From 3cc88073541f9c35cf9778fcd4334b92cf4dfed1 Mon Sep 17 00:00:00 2001 From: "dennis.jeong" <3719829+w0nche0l@users.noreply.github.com> Date: Wed, 29 Jul 2026 19:49:25 +0000 Subject: [PATCH] fix(docs): strip .mdx extensions from generated docs links Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> --- .github/workflows/docs-nav.yaml | 36 +++++++++ .github/workflows/speakeasy_run_on_pr.yaml | 3 + docs/models/activityresponse.mdx | 2 +- docs/models/additionaltoolsitem.mdx | 4 +- .../additionaltoolsitemtoolfunction.mdx | 2 +- docs/models/advisorreasoning.mdx | 2 +- docs/models/advisorservertoolconfig.mdx | 4 +- docs/models/advisorservertoolopenrouter.mdx | 4 +- docs/models/agentmessageitem.mdx | 4 +- .../agentmessageitemcontentinputimage.mdx | 2 +- .../anthropicadvisormessageusageiteration.mdx | 4 +- docs/models/anthropicbase64imagesource.mdx | 2 +- docs/models/anthropicbase64pdfsource.mdx | 2 +- .../models/anthropiccachecontroldirective.mdx | 4 +- .../anthropiccompactionusageiteration.mdx | 4 +- docs/models/anthropicdocumentblockparam.mdx | 4 +- docs/models/anthropicfile.mdx | 4 +- docs/models/anthropicfiledeleted.mdx | 2 +- docs/models/anthropicfilelist.mdx | 2 +- docs/models/anthropicimageblockparam.mdx | 2 +- .../anthropicinputtokensclearatleast.mdx | 2 +- .../models/anthropicmessageusageiteration.mdx | 4 +- docs/models/anthropicplaintextsource.mdx | 2 +- .../anthropicsearchresultblockparam.mdx | 6 +- docs/models/anthropictextblockparam.mdx | 2 +- docs/models/anthropicthinkingturns.mdx | 2 +- docs/models/anthropictoolsearchtoolbm25.mdx | 8 +- docs/models/anthropictoolsearchtoolregex.mdx | 8 +- docs/models/anthropictooluseskeep.mdx | 2 +- .../models/anthropicunknownusageiteration.mdx | 2 +- .../anthropicwebsearchresultblockparam.mdx | 2 +- .../anthropicwebsearchtooluserlocation.mdx | 2 +- docs/models/applypatchcallitem.mdx | 4 +- docs/models/applypatchcalloutputitem.mdx | 4 +- docs/models/applypatchservertool.mdx | 2 +- docs/models/applypatchservertoolconfig.mdx | 2 +- .../models/applypatchservertoolopenrouter.mdx | 4 +- docs/models/apprankingsresponse.mdx | 4 +- docs/models/architecture.mdx | 8 +- docs/models/autobetarouterplugin.mdx | 2 +- docs/models/autorouterplugin.mdx | 2 +- docs/models/baseinputsmessage.mdx | 2 +- docs/models/basereasoningconfig.mdx | 8 +- docs/models/bashservertool.mdx | 4 +- docs/models/bashservertoolconfig.mdx | 2 +- .../bulkaddworkspacemembersresponse.mdx | 2 +- docs/models/byokkey.mdx | 2 +- docs/models/chatassistantimages.mdx | 2 +- docs/models/chatassistantmessage.mdx | 8 +- docs/models/chatchoice.mdx | 6 +- docs/models/chatcontentaudio.mdx | 2 +- docs/models/chatcontentcachecontrol.mdx | 4 +- docs/models/chatcontentfile.mdx | 2 +- docs/models/chatcontentimage.mdx | 2 +- docs/models/chatcontentimageimageurl.mdx | 2 +- docs/models/chatcontenttext.mdx | 6 +- docs/models/chatcontentvideo.mdx | 2 +- docs/models/chatformatjsonschemaconfig.mdx | 2 +- docs/models/chatfunctiontoolfunction.mdx | 6 +- docs/models/chatnamedtoolchoice.mdx | 4 +- docs/models/chatrequest.mdx | 22 +++--- docs/models/chatrequestreasoning.mdx | 4 +- docs/models/chatresult.mdx | 8 +- docs/models/chatsearchmodelsservertool.mdx | 4 +- docs/models/chatstreamchoice.mdx | 6 +- docs/models/chatstreamchunk.mdx | 10 +-- docs/models/chatstreamchunkerror.mdx | 2 +- docs/models/chatstreamchunkmetadata.mdx | 2 +- docs/models/chatstreamdelta.mdx | 6 +- docs/models/chatstreamingresponse.mdx | 2 +- docs/models/chatstreamtoolcall.mdx | 4 +- docs/models/chattokenlogprob.mdx | 2 +- docs/models/chattokenlogprobs.mdx | 4 +- docs/models/chattoolcall.mdx | 4 +- docs/models/chatusage.mdx | 8 +- docs/models/chatwebsearchshorthand.mdx | 10 +-- docs/models/codeinterpreterservertool.mdx | 2 +- docs/models/codexlocalshelltool.mdx | 2 +- docs/models/compactionitem.mdx | 2 +- docs/models/compoundfilter.mdx | 2 +- docs/models/computeruseservertool.mdx | 4 +- docs/models/containerauto.mdx | 4 +- docs/models/contentcompaction.mdx | 2 +- docs/models/contentfilterbuiltinentry.mdx | 6 +- .../models/contentfilterbuiltinentryinput.mdx | 6 +- docs/models/contentfilterentry.mdx | 2 +- docs/models/contentpartaudio.mdx | 2 +- docs/models/contentpartimage.mdx | 4 +- docs/models/contentpartinputaudio.mdx | 2 +- docs/models/contentpartinputfile.mdx | 2 +- docs/models/contentpartinputvideo.mdx | 2 +- docs/models/contentpartvideo.mdx | 2 +- docs/models/contentservertooluse.mdx | 2 +- docs/models/contenttoolresult.mdx | 2 +- docs/models/contenttooluse.mdx | 2 +- docs/models/contentwebsearchtoolresult.mdx | 2 +- .../contentwebsearchtoolresulterror.mdx | 4 +- docs/models/contextcompactionitem.mdx | 2 +- docs/models/contextcompressionplugin.mdx | 2 +- docs/models/contradiction.mdx | 2 +- docs/models/createbyokkeyrequest.mdx | 2 +- docs/models/createbyokkeyresponse.mdx | 2 +- docs/models/createguardrailrequest.mdx | 6 +- docs/models/createguardrailresponse.mdx | 2 +- .../createobservabilitydestinationrequest.mdx | 4 +- .../createpresetfrominferenceresponse.mdx | 2 +- docs/models/createworkspaceresponse.mdx | 2 +- docs/models/customtool.mdx | 2 +- docs/models/customtoolcallitem.mdx | 2 +- docs/models/customtoolcalloutputitem.mdx | 2 +- ...stomtoolcalloutputitemoutputinputimage.mdx | 2 +- docs/models/datetimeservertool.mdx | 4 +- docs/models/debug.mdx | 2 +- docs/models/debugevent.mdx | 2 +- docs/models/easyinputmessage.mdx | 2 +- .../easyinputmessagecontentinputimage.mdx | 2 +- docs/models/editcleartooluses20250919.mdx | 4 +- docs/models/editcompact20260112.mdx | 2 +- docs/models/endpointsmetadata.mdx | 2 +- .../models/errors/badgatewayresponseerror.mdx | 2 +- .../models/errors/badrequestresponseerror.mdx | 2 +- docs/models/errors/conflictresponseerror.mdx | 2 +- .../edgenetworktimeoutresponseerror.mdx | 2 +- docs/models/errors/forbiddenresponseerror.mdx | 2 +- .../errors/internalserverresponseerror.mdx | 2 +- docs/models/errors/notfoundresponseerror.mdx | 2 +- .../errors/payloadtoolargeresponseerror.mdx | 2 +- .../errors/paymentrequiredresponseerror.mdx | 2 +- .../provideroverloadedresponseerror.mdx | 2 +- .../errors/requesttimeoutresponseerror.mdx | 2 +- .../serviceunavailableresponseerror.mdx | 2 +- .../errors/toomanyrequestsresponseerror.mdx | 2 +- .../errors/unauthorizedresponseerror.mdx | 2 +- .../unprocessableentityresponseerror.mdx | 2 +- docs/models/fileparserplugin.mdx | 2 +- docs/models/filesearchservertool.mdx | 4 +- docs/models/filesservertool.mdx | 4 +- docs/models/filters.mdx | 2 +- docs/models/formatgrammar.mdx | 2 +- docs/models/frameimage.mdx | 6 +- docs/models/functioncallitem.mdx | 4 +- docs/models/functioncalloutputitem.mdx | 4 +- ...functioncalloutputitemoutputinputimage.mdx | 2 +- docs/models/fusionanalysisresult.mdx | 6 +- .../fusioncallanalysiscompletedevent.mdx | 2 +- docs/models/fusionplugin.mdx | 4 +- docs/models/fusionservertoolconfig.mdx | 6 +- .../fusionservertoolconfigreasoning.mdx | 2 +- docs/models/fusionservertoolopenrouter.mdx | 4 +- docs/models/generationcontentdata.mdx | 2 +- docs/models/generationcontentresponse.mdx | 2 +- docs/models/generationresponse.mdx | 2 +- docs/models/generationresponsedata.mdx | 6 +- docs/models/getbyokkeyresponse.mdx | 2 +- docs/models/getguardrailresponse.mdx | 2 +- docs/models/getpresetresponse.mdx | 2 +- docs/models/getpresetversionresponse.mdx | 2 +- docs/models/getworkspaceresponse.mdx | 2 +- docs/models/guardrail.mdx | 6 +- docs/models/imageendpoint.mdx | 2 +- docs/models/imagegencompletedevent.mdx | 2 +- .../imagegenerationproviderpreferences.mdx | 2 +- docs/models/imagegenerationrequest.mdx | 14 ++-- docs/models/imagegenerationresponse.mdx | 4 +- docs/models/imagegenerationservertool.mdx | 14 ++-- .../imagegenerationservertoolopenrouter.mdx | 4 +- docs/models/imagegenerationusage.mdx | 12 +-- docs/models/imagegenstreamerrorevent.mdx | 2 +- docs/models/imagegentextchunkevent.mdx | 2 +- docs/models/imagemodelarchitecture.mdx | 4 +- docs/models/imagemodelendpointsresponse.mdx | 2 +- docs/models/imagemodellistitem.mdx | 2 +- docs/models/imagemodelslistresponse.mdx | 2 +- docs/models/imagepricingentry.mdx | 4 +- docs/models/incompletedetails.mdx | 2 +- docs/models/inputaudio.mdx | 2 +- docs/models/inputaudioinputaudio.mdx | 2 +- docs/models/inputimage.mdx | 4 +- docs/models/inputmessageitem.mdx | 2 +- .../inputmessageitemcontentinputimage.mdx | 2 +- docs/models/inputsmessage.mdx | 4 +- docs/models/inputsreasoning.mdx | 8 +- docs/models/inputtext.mdx | 2 +- docs/models/itemreferenceitem.mdx | 2 +- docs/models/keepall.mdx | 2 +- docs/models/legacychatcontentvideo.mdx | 2 +- docs/models/legacywebsearchservertool.mdx | 10 +-- docs/models/listbyokkeysresponse.mdx | 2 +- docs/models/listendpointsresponse.mdx | 4 +- docs/models/listguardrailsresponse.mdx | 2 +- docs/models/listkeyassignmentsresponse.mdx | 2 +- docs/models/listmemberassignmentsresponse.mdx | 2 +- docs/models/listpresetsresponse.mdx | 2 +- docs/models/listpresetversionsresponse.mdx | 2 +- docs/models/listworkspacebudgetsresponse.mdx | 2 +- docs/models/listworkspacemembersresponse.mdx | 2 +- docs/models/listworkspacesresponse.mdx | 2 +- docs/models/localshellcallitem.mdx | 6 +- docs/models/localshellcallitemaction.mdx | 2 +- docs/models/localshellcalloutputitem.mdx | 4 +- docs/models/logprob.mdx | 2 +- docs/models/mcpapprovalrequestitem.mdx | 2 +- docs/models/mcpapprovalresponseitem.mdx | 2 +- docs/models/mcpcallitem.mdx | 2 +- docs/models/mcplisttoolsitem.mdx | 4 +- docs/models/mcpservertool.mdx | 4 +- docs/models/messagesmessageparam.mdx | 2 +- docs/models/messagesoutputconfig.mdx | 6 +- docs/models/messagesoutputconfigformat.mdx | 2 +- docs/models/messagesrequest.mdx | 18 ++--- .../models/messagessearchmodelsservertool.mdx | 4 +- docs/models/messagestooladditionblock.mdx | 2 +- docs/models/messagestoolremovalblock.mdx | 2 +- docs/models/model.mdx | 18 ++--- docs/models/modelarchitecture.mdx | 8 +- docs/models/modelbenchmarks.mdx | 4 +- docs/models/modelreasoning.mdx | 4 +- docs/models/modelresponse.mdx | 2 +- docs/models/modelscountresponse.mdx | 2 +- docs/models/modelslistresponse.mdx | 4 +- docs/models/namespacefunctiontool.mdx | 2 +- docs/models/namespacetool.mdx | 2 +- docs/models/observabilityarizedestination.mdx | 4 +- .../observabilitybraintrustdestination.mdx | 4 +- .../observabilityclickhousedestination.mdx | 4 +- .../observabilitydatadogdestination.mdx | 4 +- docs/models/observabilityfilterrulegroup.mdx | 4 +- .../models/observabilityfilterrulesconfig.mdx | 2 +- ...observabilityfilterrulesconfignullable.mdx | 2 +- .../observabilitygrafanadestination.mdx | 4 +- .../observabilitylangfusedestination.mdx | 4 +- .../observabilitylangsmithdestination.mdx | 4 +- .../observabilitynewrelicdestination.mdx | 4 +- ...observabilitynewrelicdestinationconfig.mdx | 2 +- docs/models/observabilityopikdestination.mdx | 4 +- .../observabilityotelcollectordestination.mdx | 4 +- .../observabilityposthogdestination.mdx | 4 +- docs/models/observabilityrampdestination.mdx | 4 +- docs/models/observabilitys3destination.mdx | 4 +- .../models/observabilitysentrydestination.mdx | 4 +- .../observabilitysnowflakedestination.mdx | 4 +- docs/models/observabilityweavedestination.mdx | 4 +- .../observabilitywebhookdestination.mdx | 4 +- .../observabilitywebhookdestinationconfig.mdx | 2 +- docs/models/openaifile.mdx | 8 +- docs/models/openaifiledeleted.mdx | 2 +- docs/models/openaifilelist.mdx | 4 +- docs/models/openairesponsecustomtoolcall.mdx | 2 +- .../openairesponsecustomtoolcalloutput.mdx | 2 +- .../models/openairesponsefunctiontoolcall.mdx | 4 +- .../openairesponsefunctiontoolcalloutput.mdx | 4 +- .../models/openairesponseinputmessageitem.mdx | 2 +- .../openairesponsestoolchoiceapplypatch.mdx | 2 +- .../openairesponsestoolchoicefunction.mdx | 2 +- .../models/openairesponsestoolchoiceshell.mdx | 2 +- docs/models/openresponsescreatedevent.mdx | 2 +- docs/models/openresponsesinprogressevent.mdx | 2 +- docs/models/openresponsesresult.mdx | 24 +++--- docs/models/openrouterfile.mdx | 4 +- docs/models/openrouterfiledeleted.mdx | 2 +- docs/models/openrouterfilelist.mdx | 2 +- docs/models/openroutermetadata.mdx | 10 +-- docs/models/openrouterwebsearchservertool.mdx | 4 +- .../bulkaddworkspacemembersrequest.mdx | 2 +- .../bulkassignkeystoguardrailrequest.mdx | 2 +- .../bulkassignmemberstoguardrailrequest.mdx | 2 +- .../bulkremoveworkspacemembersrequest.mdx | 2 +- .../bulkunassignkeysfromguardrailrequest.mdx | 2 +- ...ulkunassignmembersfromguardrailrequest.mdx | 2 +- docs/models/operations/classifierfilters.mdx | 2 +- docs/models/operations/contentimageurl.mdx | 2 +- .../operations/createaudiospeechrequest.mdx | 2 +- ...ateaudiotranscriptionsmultipartrequest.mdx | 2 +- ...udiotranscriptionsmultipartrequestbody.mdx | 6 +- .../createaudiotranscriptionsrequest.mdx | 2 +- .../operations/createauthkeyscoderequest.mdx | 2 +- .../createauthkeyscoderequestbody.mdx | 4 +- .../operations/createauthkeyscoderesponse.mdx | 2 +- .../operations/createbyokkeyrequest.mdx | 2 +- .../operations/createembeddingsdata.mdx | 2 +- .../operations/createembeddingsrequest.mdx | 2 +- .../createembeddingsrequestbody.mdx | 4 +- .../createembeddingsresponsebody.mdx | 6 +- .../operations/createembeddingsusage.mdx | 4 +- .../operations/createguardrailrequest.mdx | 2 +- .../models/operations/createimagesrequest.mdx | 2 +- docs/models/operations/createkeysrequest.mdx | 2 +- .../operations/createkeysrequestbody.mdx | 2 +- docs/models/operations/createkeysresponse.mdx | 2 +- .../createobservabilitydestinationrequest.mdx | 2 +- .../createpresetschatcompletionsrequest.mdx | 2 +- .../createpresetsmessagesrequest.mdx | 2 +- .../createpresetsresponsesrequest.mdx | 2 +- .../models/operations/creatererankrequest.mdx | 2 +- .../operations/creatererankrequestbody.mdx | 2 +- .../operations/creatererankresponsebody.mdx | 4 +- .../operations/createresponsesrequest.mdx | 4 +- .../models/operations/createvideosrequest.mdx | 2 +- .../operations/createworkspacerequest.mdx | 2 +- docs/models/operations/deletefilerequest.mdx | 2 +- .../deleteworkspacebudgetrequest.mdx | 2 +- .../operations/downloadfilecontentrequest.mdx | 2 +- .../exchangeauthcodeforapikeyrequest.mdx | 2 +- .../exchangeauthcodeforapikeyrequestbody.mdx | 2 +- .../operations/getanalyticsmetadata.mdx | 8 +- .../operations/getanalyticsmetaresponse.mdx | 2 +- .../operations/getapprankingsrequest.mdx | 6 +- .../operations/getapprankingsresponse.mdx | 2 +- .../operations/getbenchmarksrequest.mdx | 6 +- docs/models/operations/getcreditsresponse.mdx | 2 +- docs/models/operations/getcurrentkeydata.mdx | 2 +- .../operations/getcurrentkeyresponse.mdx | 2 +- .../operations/getfilemetadatarequest.mdx | 2 +- docs/models/operations/getkeyresponse.mdx | 2 +- docs/models/operations/getmodelsrequest.mdx | 10 +-- docs/models/operations/getmodelsresponse.mdx | 2 +- .../operations/getrankingsdailyrequest.mdx | 10 +-- .../gettaskclassificationsrequest.mdx | 2 +- docs/models/operations/granularity.mdx | 2 +- .../models/operations/listbyokkeysrequest.mdx | 2 +- .../operations/listbyokkeysresponse.mdx | 2 +- .../listembeddingsmodelsresponse.mdx | 2 +- .../operations/listendpointsresponse.mdx | 2 +- .../operations/listendpointszdrresponse.mdx | 2 +- docs/models/operations/listfilesrequest.mdx | 4 +- .../listguardrailkeyassignmentsresponse.mdx | 2 +- ...listguardrailmemberassignmentsresponse.mdx | 2 +- .../operations/listguardrailsresponse.mdx | 2 +- .../operations/listkeyassignmentsresponse.mdx | 2 +- .../listmemberassignmentsresponse.mdx | 2 +- .../operations/listmodelsuserresponse.mdx | 2 +- .../listobservabilitydestinationsresponse.mdx | 2 +- .../listorganizationmembersdata.mdx | 2 +- .../listorganizationmembersresponse.mdx | 2 +- .../listorganizationmembersresponsebody.mdx | 2 +- .../models/operations/listpresetsresponse.mdx | 2 +- .../operations/listpresetversionsresponse.mdx | 2 +- docs/models/operations/listprovidersdata.mdx | 4 +- .../operations/listprovidersresponse.mdx | 2 +- docs/models/operations/listresponse.mdx | 2 +- .../listworkspacemembersresponse.mdx | 2 +- .../operations/listworkspacesresponse.mdx | 2 +- docs/models/operations/metric.mdx | 2 +- docs/models/operations/operator.mdx | 4 +- docs/models/operations/orderby.mdx | 2 +- .../models/operations/queryanalyticsdata2.mdx | 4 +- .../operations/queryanalyticsrequest.mdx | 2 +- .../operations/queryanalyticsrequestbody.mdx | 10 +-- .../operations/queryanalyticsresponse.mdx | 2 +- docs/models/operations/result.mdx | 2 +- .../sendchatcompletionrequestrequest.mdx | 4 +- .../submitgenerationfeedbackrequest.mdx | 2 +- .../operations/updatebyokkeyrequest.mdx | 2 +- .../operations/updateguardrailrequest.mdx | 2 +- docs/models/operations/updatekeysrequest.mdx | 2 +- .../operations/updatekeysrequestbody.mdx | 2 +- docs/models/operations/updatekeysresponse.mdx | 2 +- .../updateobservabilitydestinationrequest.mdx | 2 +- .../operations/updateworkspacerequest.mdx | 2 +- docs/models/operations/uploadfilerequest.mdx | 4 +- .../operations/uploadfilerequestbody.mdx | 2 +- .../upsertworkspacebudgetrequest.mdx | 4 +- docs/models/outputadvisorservertoolitem.mdx | 4 +- docs/models/outputapplypatchcallitem.mdx | 2 +- .../models/outputapplypatchservertoolitem.mdx | 4 +- docs/models/outputbashservertoolitem.mdx | 4 +- .../models/outputbrowseruseservertoolitem.mdx | 4 +- docs/models/outputcodeinterpretercallitem.mdx | 4 +- .../outputcodeinterpreterservertoolitem.mdx | 4 +- docs/models/outputcomputercallitem.mdx | 6 +- docs/models/outputcustomtoolcallitem.mdx | 2 +- docs/models/outputdatetimeitem.mdx | 4 +- docs/models/outputfilesearchcallitem.mdx | 4 +- .../models/outputfilesearchservertoolitem.mdx | 4 +- docs/models/outputfilesservertoolitem.mdx | 4 +- docs/models/outputfunctioncallitem.mdx | 2 +- docs/models/outputfusionservertoolitem.mdx | 12 +-- docs/models/outputimagegenerationcallitem.mdx | 4 +- .../outputimagegenerationservertoolitem.mdx | 4 +- docs/models/outputitemimagegenerationcall.mdx | 4 +- docs/models/outputmcpservertoolitem.mdx | 4 +- docs/models/outputmemoryservertoolitem.mdx | 6 +- docs/models/outputmessage.mdx | 4 +- docs/models/outputmessageitem.mdx | 2 +- docs/models/outputreasoningitem.mdx | 6 +- .../outputsearchmodelsservertoolitem.mdx | 4 +- docs/models/outputshellcallitem.mdx | 4 +- docs/models/outputshellcalloutputitem.mdx | 4 +- docs/models/outputsubagentservertoolitem.mdx | 4 +- .../models/outputtexteditorservertoolitem.mdx | 6 +- .../models/outputtoolsearchservertoolitem.mdx | 4 +- docs/models/outputwebfetchservertoolitem.mdx | 4 +- docs/models/outputwebsearchcallitem.mdx | 4 +- .../outputwebsearchcallitemactionsearch.mdx | 2 +- docs/models/outputwebsearchservertoolitem.mdx | 6 +- .../outputwebsearchservertoolitemaction.mdx | 4 +- .../outputwebsearchservertoolitemsource.mdx | 2 +- docs/models/paretorouterplugin.mdx | 2 +- docs/models/pipelinestage.mdx | 2 +- docs/models/prediction.mdx | 2 +- docs/models/predictioncontenttext.mdx | 2 +- docs/models/preset.mdx | 2 +- docs/models/presetwithdesignatedversion.mdx | 4 +- .../preview20250311websearchservertool.mdx | 10 +-- docs/models/previewwebsearchservertool.mdx | 10 +-- docs/models/previewwebsearchuserlocation.mdx | 2 +- docs/models/pricing.mdx | 2 +- docs/models/promptcachebreakpoint.mdx | 2 +- docs/models/promptcacheoptions.mdx | 2 +- docs/models/providerpreferences.mdx | 6 +- docs/models/providerresponse.mdx | 4 +- docs/models/providersortconfig.mdx | 4 +- docs/models/publicendpoint.mdx | 14 ++-- docs/models/publicpricing.mdx | 2 +- docs/models/rankingoptions.mdx | 2 +- docs/models/rankingsdailymeta.mdx | 2 +- docs/models/rankingsdailyresponse.mdx | 4 +- docs/models/reasoningconfig.mdx | 8 +- docs/models/reasoningdetailencrypted.mdx | 2 +- docs/models/reasoningdetailservertoolcall.mdx | 2 +- docs/models/reasoningdetailsummary.mdx | 2 +- docs/models/reasoningdetailtext.mdx | 2 +- docs/models/reasoningitem.mdx | 8 +- .../models/reasoningsummarypartaddedevent.mdx | 2 +- docs/models/reasoningsummarypartdoneevent.mdx | 2 +- docs/models/reasoningsummarytext.mdx | 2 +- docs/models/reasoningtextcontent.mdx | 2 +- docs/models/requireapproval.mdx | 4 +- docs/models/responseoutputtext.mdx | 2 +- docs/models/responseserrorfield.mdx | 2 +- docs/models/responsesrequest.mdx | 24 +++--- docs/models/rule.mdx | 4 +- .../searchmodelsservertoolopenrouter.mdx | 4 +- docs/models/shellcallitem.mdx | 6 +- docs/models/shellcalloutputitem.mdx | 6 +- docs/models/shellservertool.mdx | 2 +- docs/models/shellservertoolconfig.mdx | 2 +- docs/models/shellservertoolopenrouter.mdx | 4 +- docs/models/speechrequest.mdx | 4 +- docs/models/speechrequestprovider.mdx | 2 +- docs/models/streameventsresponsecompleted.mdx | 2 +- docs/models/streameventsresponsefailed.mdx | 2 +- .../models/streameventsresponseincomplete.mdx | 2 +- docs/models/streamlogprob.mdx | 2 +- docs/models/sttrequest.mdx | 8 +- docs/models/sttrequestprovider.mdx | 2 +- docs/models/sttresponse.mdx | 6 +- docs/models/subagentreasoning.mdx | 2 +- docs/models/subagentservertoolconfig.mdx | 4 +- docs/models/subagentservertoolopenrouter.mdx | 4 +- .../submitgenerationfeedbackrequest.mdx | 2 +- .../submitgenerationfeedbackresponse.mdx | 2 +- docs/models/taskbudget.mdx | 2 +- docs/models/taskclassificationitem.mdx | 2 +- docs/models/taskclassificationresponse.mdx | 2 +- .../models/taskclassificationresponsedata.mdx | 4 +- docs/models/textdeltaevent.mdx | 2 +- docs/models/textdoneevent.mdx | 2 +- docs/models/textextendedconfig.mdx | 2 +- docs/models/thinkingadaptive.mdx | 2 +- docs/models/thinkingenabled.mdx | 2 +- docs/models/timings.mdx | 2 +- docs/models/tooladvisor20260301.mdx | 10 +-- docs/models/toolbash20250124.mdx | 6 +- docs/models/toolchoiceallowed.mdx | 2 +- docs/models/toolcustom.mdx | 6 +- docs/models/tooltexteditor20250124.mdx | 6 +- docs/models/toolwebsearch20250305.mdx | 8 +- docs/models/toolwebsearch20260209.mdx | 10 +-- docs/models/triggerinputtokens.mdx | 2 +- docs/models/unifiedbenchmarksaaitem.mdx | 2 +- docs/models/unifiedbenchmarksdaitem.mdx | 4 +- docs/models/unifiedbenchmarksmeta.mdx | 4 +- docs/models/unifiedbenchmarksoritem.mdx | 2 +- docs/models/unifiedbenchmarksresponse.mdx | 2 +- docs/models/updatebyokkeyresponse.mdx | 2 +- docs/models/updateguardrailrequest.mdx | 6 +- docs/models/updateguardrailresponse.mdx | 2 +- .../updateobservabilitydestinationrequest.mdx | 2 +- docs/models/updateworkspaceresponse.mdx | 2 +- docs/models/upsertworkspacebudgetresponse.mdx | 2 +- docs/models/usage.mdx | 8 +- docs/models/userlocation.mdx | 2 +- docs/models/videogenerationrequest.mdx | 8 +- .../models/videogenerationrequestprovider.mdx | 2 +- docs/models/videogenerationresponse.mdx | 4 +- docs/models/videomodel.mdx | 8 +- docs/models/videomodelslistresponse.mdx | 2 +- docs/models/webfetchservertool.mdx | 4 +- docs/models/webfetchservertoolconfig.mdx | 2 +- docs/models/websearchconfig.mdx | 6 +- docs/models/websearchplugin.mdx | 4 +- docs/models/websearchservertool.mdx | 10 +-- docs/models/websearchservertoolconfig.mdx | 6 +- docs/models/websearchservertoolopenrouter.mdx | 4 +- docs/models/websearchsource.mdx | 2 +- docs/models/websearchuserlocation.mdx | 2 +- .../websearchuserlocationservertool.mdx | 2 +- docs/models/workspacebudget.mdx | 2 +- docs/models/workspacemember.mdx | 2 +- docs/sdks/analytics/README.mdx | 6 +- docs/sdks/apikeys/README.mdx | 36 ++++----- docs/sdks/benchmarks/README.mdx | 6 +- docs/sdks/betaanalytics/README.mdx | 12 +-- docs/sdks/betaresponses/README.mdx | 6 +- docs/sdks/byok/README.mdx | 30 +++---- docs/sdks/chat/README.mdx | 6 +- docs/sdks/classifications/README.mdx | 6 +- docs/sdks/credits/README.mdx | 6 +- docs/sdks/datasets/README.mdx | 12 +-- docs/sdks/embeddings/README.mdx | 12 +-- docs/sdks/endpoints/README.mdx | 12 +-- docs/sdks/files/README.mdx | 30 +++---- docs/sdks/generations/README.mdx | 18 ++--- docs/sdks/guardrails/README.mdx | 78 +++++++++---------- docs/sdks/images/README.mdx | 18 ++--- docs/sdks/models/README.mdx | 26 +++---- docs/sdks/oauth/README.mdx | 12 +-- docs/sdks/observability/README.mdx | 30 +++---- docs/sdks/organization/README.mdx | 6 +- docs/sdks/presets/README.mdx | 42 +++++----- docs/sdks/providers/README.mdx | 6 +- docs/sdks/rerank/README.mdx | 6 +- docs/sdks/responses/README.mdx | 6 +- docs/sdks/stt/README.mdx | 12 +-- docs/sdks/tts/README.mdx | 6 +- docs/sdks/videogeneration/README.mdx | 24 +++--- docs/sdks/workspaces/README.mdx | 66 ++++++++-------- scripts/fix-docs-links.sh | 53 +++++++++++++ 529 files changed, 1231 insertions(+), 1139 deletions(-) create mode 100644 .github/workflows/docs-nav.yaml create mode 100755 scripts/fix-docs-links.sh diff --git a/.github/workflows/docs-nav.yaml b/.github/workflows/docs-nav.yaml new file mode 100644 index 000000000..be3911255 --- /dev/null +++ b/.github/workflows/docs-nav.yaml @@ -0,0 +1,36 @@ +name: Docs navigation + +permissions: + contents: write + pull-requests: write + +on: + workflow_dispatch: + pull_request: + paths: + - "docs/**" + - "scripts/gen-docs-nav.sh" + - "scripts/fix-docs-links.sh" + - ".github/workflows/docs-nav.yaml" + +jobs: + gen-docs-nav: + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v5 + with: + ref: ${{ github.event.pull_request.head.ref }} + token: ${{ secrets.GITHUB_TOKEN }} + + # jq is preinstalled on GitHub-hosted ubuntu runners. + - name: Regenerate docs navigation + run: scripts/gen-docs-nav.sh + + - name: Strip .mdx extensions from docs links + run: scripts/fix-docs-links.sh + + - name: Auto-commit docs post-processing + uses: int128/update-generated-files-action@v2 + with: + commit-message: "Chore: regenerate docs navigation and fix docs links" diff --git a/.github/workflows/speakeasy_run_on_pr.yaml b/.github/workflows/speakeasy_run_on_pr.yaml index 75c6bd8b5..2fe625b7e 100644 --- a/.github/workflows/speakeasy_run_on_pr.yaml +++ b/.github/workflows/speakeasy_run_on_pr.yaml @@ -47,6 +47,9 @@ jobs: - name: Regenerate docs navigation run: scripts/gen-docs-nav.sh + - name: Strip .mdx extensions from docs links + run: scripts/fix-docs-links.sh + - name: Validate SDK uses: ./.github/actions/validate-sdk with: diff --git a/docs/models/activityresponse.mdx b/docs/models/activityresponse.mdx index 51f158846..8a0cdb6c5 100644 --- a/docs/models/activityresponse.mdx +++ b/docs/models/activityresponse.mdx @@ -30,4 +30,4 @@ let value: ActivityResponse = { | Field | Type | Required | Description | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `data` | [models.ActivityItem](../models/activityitem.mdx)[] | :heavy_check_mark: | List of activity items | \ No newline at end of file +| `data` | [models.ActivityItem](../models/activityitem)[] | :heavy_check_mark: | List of activity items | \ No newline at end of file diff --git a/docs/models/additionaltoolsitem.mdx b/docs/models/additionaltoolsitem.mdx index 4ec7672df..b3317aed7 100644 --- a/docs/models/additionaltoolsitem.mdx +++ b/docs/models/additionaltoolsitem.mdx @@ -25,6 +25,6 @@ let value: AdditionalToolsItem = { | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | | `id` | *string* | :heavy_minus_sign: | N/A | -| `role` | [models.AdditionalToolsItemRole](../models/additionaltoolsitemrole.mdx) | :heavy_check_mark: | N/A | +| `role` | [models.AdditionalToolsItemRole](../models/additionaltoolsitemrole) | :heavy_check_mark: | N/A | | `tools` | *models.AdditionalToolsItemToolUnion*[] | :heavy_check_mark: | N/A | -| `type` | [models.TypeAdditionalTools](../models/typeadditionaltools.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.TypeAdditionalTools](../models/typeadditionaltools) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/additionaltoolsitemtoolfunction.mdx b/docs/models/additionaltoolsitemtoolfunction.mdx index f119670da..3c8bd1bba 100644 --- a/docs/models/additionaltoolsitemtoolfunction.mdx +++ b/docs/models/additionaltoolsitemtoolfunction.mdx @@ -43,4 +43,4 @@ let value: AdditionalToolsItemToolFunction = { | `name` | *string* | :heavy_check_mark: | N/A | | `parameters` | Record\ | :heavy_check_mark: | N/A | | `strict` | *boolean* | :heavy_minus_sign: | N/A | -| `type` | [models.AdditionalToolsItemTypeFunction](../models/additionaltoolsitemtypefunction.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.AdditionalToolsItemTypeFunction](../models/additionaltoolsitemtypefunction) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/advisorreasoning.mdx b/docs/models/advisorreasoning.mdx index 99f59604d..54f5b2605 100644 --- a/docs/models/advisorreasoning.mdx +++ b/docs/models/advisorreasoning.mdx @@ -16,5 +16,5 @@ let value: AdvisorReasoning = {}; | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `effort` | [models.AdvisorReasoningEffort](../models/advisorreasoningeffort.mdx) | :heavy_minus_sign: | Reasoning effort level for the advisor call. | +| `effort` | [models.AdvisorReasoningEffort](../models/advisorreasoningeffort) | :heavy_minus_sign: | Reasoning effort level for the advisor call. | | `maxTokens` | *number* | :heavy_minus_sign: | Maximum number of reasoning tokens the advisor may use. | \ No newline at end of file diff --git a/docs/models/advisorservertoolconfig.mdx b/docs/models/advisorservertoolconfig.mdx index de7b9806a..695b8ce26 100644 --- a/docs/models/advisorservertoolconfig.mdx +++ b/docs/models/advisorservertoolconfig.mdx @@ -22,7 +22,7 @@ let value: AdvisorServerToolConfig = {}; | `maxToolCalls` | *number* | :heavy_minus_sign: | Maximum number of tool-calling steps the advisor sub-agent may take during its agentic loop. Capped at 25. Only relevant when the advisor is given tools. | 5 | | `model` | *string* | :heavy_minus_sign: | Slug of the advisor model to consult (any OpenRouter model). When omitted, the executor can choose it via the tool call's `model` argument; if neither is set, the model from the outer API request is used. The advisor tool itself cannot be the advisor model. | ~anthropic/claude-opus-latest | | `name` | *string* | :heavy_minus_sign: | Optional name for this advisor. The model sees one tool per named advisor (and one default for an unnamed entry). Names must be unique across advisor entries. Letters, digits, spaces, underscores, and dashes; trimmed; 1–64 chars. | reviewer | -| `reasoning` | [models.AdvisorReasoning](../models/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"
} | +| `reasoning` | [models.AdvisorReasoning](../models/advisorreasoning) | :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` | *boolean* | :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` | *number* | :heavy_minus_sign: | Sampling temperature forwarded to the advisor call. When omitted, the provider's default applies. | 0.7 | -| `tools` | [models.AdvisorNestedTool](../models/advisornestedtool.mdx)[] | :heavy_minus_sign: | Tools the advisor sub-agent may use while forming its advice. The advisor runs as an agentic sub-agent over these tools, then returns its text. Only OpenRouter server tools are supported — function tools are rejected — and the list must not include the advisor tool itself. | | \ No newline at end of file +| `tools` | [models.AdvisorNestedTool](../models/advisornestedtool)[] | :heavy_minus_sign: | Tools the advisor sub-agent may use while forming its advice. The advisor runs as an agentic sub-agent over these tools, then returns its text. Only OpenRouter server tools are supported — function tools are rejected — and the list must not include the advisor tool itself. | | \ No newline at end of file diff --git a/docs/models/advisorservertoolopenrouter.mdx b/docs/models/advisorservertoolopenrouter.mdx index 8911c4445..5f52a23f7 100644 --- a/docs/models/advisorservertoolopenrouter.mdx +++ b/docs/models/advisorservertoolopenrouter.mdx @@ -18,5 +18,5 @@ let value: AdvisorServerToolOpenRouter = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `parameters` | [models.AdvisorServerToolConfig](../models/advisorservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for one openrouter:advisor server tool entry. | \{
"model": "~anthropic/claude-opus-latest",
"name": "reviewer"
} | -| `type` | [models.AdvisorServerToolOpenRouterType](../models/advisorservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.AdvisorServerToolConfig](../models/advisorservertoolconfig) | :heavy_minus_sign: | Configuration for one openrouter:advisor server tool entry. | \{
"model": "~anthropic/claude-opus-latest",
"name": "reviewer"
} | +| `type` | [models.AdvisorServerToolOpenRouterType](../models/advisorservertoolopenroutertype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/agentmessageitem.mdx b/docs/models/agentmessageitem.mdx index 1294e512c..65c705eac 100644 --- a/docs/models/agentmessageitem.mdx +++ b/docs/models/agentmessageitem.mdx @@ -26,10 +26,10 @@ let value: AgentMessageItem = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `agent` | [models.Agent](../models/agent.mdx) | :heavy_minus_sign: | N/A | | +| `agent` | [models.Agent](../models/agent) | :heavy_minus_sign: | N/A | | | `author` | *string* | :heavy_check_mark: | N/A | | | `content` | *models.AgentMessageItemContentUnion*[] | :heavy_check_mark: | N/A | | | `id` | *string* | :heavy_minus_sign: | N/A | | | `recipient` | *string* | :heavy_check_mark: | N/A | | -| `type` | [models.TypeAgentMessage](../models/typeagentmessage.mdx) | :heavy_check_mark: | N/A | | +| `type` | [models.TypeAgentMessage](../models/typeagentmessage) | :heavy_check_mark: | N/A | | | `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \{
"author": "/root/worker",
"content": [
\{
"text": "Task complete.",
"type": "input_text"
}
],
"recipient": "/root",
"type": "agent_message"
} | \ No newline at end of file diff --git a/docs/models/agentmessageitemcontentinputimage.mdx b/docs/models/agentmessageitemcontentinputimage.mdx index d41815e3c..f4d5bf617 100644 --- a/docs/models/agentmessageitemcontentinputimage.mdx +++ b/docs/models/agentmessageitemcontentinputimage.mdx @@ -19,6 +19,6 @@ let value: AgentMessageItemContentInputImage = { | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `detail` | [models.AgentMessageItemDetail](../models/agentmessageitemdetail.mdx) | :heavy_check_mark: | N/A | +| `detail` | [models.AgentMessageItemDetail](../models/agentmessageitemdetail) | :heavy_check_mark: | N/A | | `imageUrl` | *string* | :heavy_minus_sign: | N/A | | `type` | *"input_image"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/anthropicadvisormessageusageiteration.mdx b/docs/models/anthropicadvisormessageusageiteration.mdx index c9e87a21a..0fd093572 100644 --- a/docs/models/anthropicadvisormessageusageiteration.mdx +++ b/docs/models/anthropicadvisormessageusageiteration.mdx @@ -17,10 +17,10 @@ let value: AnthropicAdvisorMessageUsageIteration = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `cacheCreation` | [models.AnthropicIterationCacheCreation](../models/anthropiciterationcachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | +| `cacheCreation` | [models.AnthropicIterationCacheCreation](../models/anthropiciterationcachecreation) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | | `cacheCreationInputTokens` | *number* | :heavy_minus_sign: | N/A | | | `cacheReadInputTokens` | *number* | :heavy_minus_sign: | N/A | | | `inputTokens` | *number* | :heavy_minus_sign: | N/A | | | `outputTokens` | *number* | :heavy_minus_sign: | N/A | | | `model` | *string* | :heavy_check_mark: | N/A | | -| `type` | [models.AnthropicAdvisorMessageUsageIterationType](../models/anthropicadvisormessageusageiterationtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `type` | [models.AnthropicAdvisorMessageUsageIterationType](../models/anthropicadvisormessageusageiterationtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/anthropicbase64imagesource.mdx b/docs/models/anthropicbase64imagesource.mdx index ed374bf24..d7d8d4da9 100644 --- a/docs/models/anthropicbase64imagesource.mdx +++ b/docs/models/anthropicbase64imagesource.mdx @@ -19,5 +19,5 @@ let value: AnthropicBase64ImageSource = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | | `data` | *string* | :heavy_check_mark: | N/A | | -| `mediaType` | [models.AnthropicImageMimeType](../models/anthropicimagemimetype.mdx) | :heavy_check_mark: | N/A | image/jpeg | +| `mediaType` | [models.AnthropicImageMimeType](../models/anthropicimagemimetype) | :heavy_check_mark: | N/A | image/jpeg | | `type` | *"base64"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/anthropicbase64pdfsource.mdx b/docs/models/anthropicbase64pdfsource.mdx index 86918e684..fff33b159 100644 --- a/docs/models/anthropicbase64pdfsource.mdx +++ b/docs/models/anthropicbase64pdfsource.mdx @@ -19,5 +19,5 @@ let value: AnthropicBase64PdfSource = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | | `data` | *string* | :heavy_check_mark: | N/A | -| `mediaType` | [models.AnthropicBase64PdfSourceMediaType](../models/anthropicbase64pdfsourcemediatype.mdx) | :heavy_check_mark: | N/A | +| `mediaType` | [models.AnthropicBase64PdfSourceMediaType](../models/anthropicbase64pdfsourcemediatype) | :heavy_check_mark: | N/A | | `type` | *"base64"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/anthropiccachecontroldirective.mdx b/docs/models/anthropiccachecontroldirective.mdx index c43209582..015df5148 100644 --- a/docs/models/anthropiccachecontroldirective.mdx +++ b/docs/models/anthropiccachecontroldirective.mdx @@ -18,5 +18,5 @@ let value: AnthropicCacheControlDirective = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `ttl` | [models.AnthropicCacheControlTtl](../models/anthropiccachecontrolttl.mdx) | :heavy_minus_sign: | N/A | 5m | -| `type` | [models.AnthropicCacheControlDirectiveType](../models/anthropiccachecontroldirectivetype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ttl` | [models.AnthropicCacheControlTtl](../models/anthropiccachecontrolttl) | :heavy_minus_sign: | N/A | 5m | +| `type` | [models.AnthropicCacheControlDirectiveType](../models/anthropiccachecontroldirectivetype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/anthropiccompactionusageiteration.mdx b/docs/models/anthropiccompactionusageiteration.mdx index a9e70b14d..f4f4a9f53 100644 --- a/docs/models/anthropiccompactionusageiteration.mdx +++ b/docs/models/anthropiccompactionusageiteration.mdx @@ -16,9 +16,9 @@ let value: AnthropicCompactionUsageIteration = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `cacheCreation` | [models.AnthropicIterationCacheCreation](../models/anthropiciterationcachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | +| `cacheCreation` | [models.AnthropicIterationCacheCreation](../models/anthropiciterationcachecreation) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | | `cacheCreationInputTokens` | *number* | :heavy_minus_sign: | N/A | | | `cacheReadInputTokens` | *number* | :heavy_minus_sign: | N/A | | | `inputTokens` | *number* | :heavy_minus_sign: | N/A | | | `outputTokens` | *number* | :heavy_minus_sign: | N/A | | -| `type` | [models.AnthropicCompactionUsageIterationType](../models/anthropiccompactionusageiterationtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `type` | [models.AnthropicCompactionUsageIterationType](../models/anthropiccompactionusageiterationtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/anthropicdocumentblockparam.mdx b/docs/models/anthropicdocumentblockparam.mdx index 15f213d3f..2d416f726 100644 --- a/docs/models/anthropicdocumentblockparam.mdx +++ b/docs/models/anthropicdocumentblockparam.mdx @@ -21,8 +21,8 @@ let value: AnthropicDocumentBlockParam = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/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` | [models.AnthropicDocumentBlockParamCitations](../models/anthropicdocumentblockparamcitations.mdx) | :heavy_minus_sign: | N/A | | +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective) | :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` | [models.AnthropicDocumentBlockParamCitations](../models/anthropicdocumentblockparamcitations) | :heavy_minus_sign: | N/A | | | `context` | *string* | :heavy_minus_sign: | N/A | | | `source` | *models.AnthropicDocumentBlockParamSourceUnion* | :heavy_check_mark: | N/A | | | `title` | *string* | :heavy_minus_sign: | N/A | | diff --git a/docs/models/anthropicfile.mdx b/docs/models/anthropicfile.mdx index 9203981c4..2c11ee743 100644 --- a/docs/models/anthropicfile.mdx +++ b/docs/models/anthropicfile.mdx @@ -25,11 +25,11 @@ let value: AnthropicFile = { | Field | Type | Required | Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `shape` | [models.AnthropicFileShape](../models/anthropicfileshape.mdx) | :heavy_check_mark: | N/A | +| `shape` | [models.AnthropicFileShape](../models/anthropicfileshape) | :heavy_check_mark: | N/A | | `createdAt` | *string* | :heavy_check_mark: | N/A | | `downloadable` | *boolean* | :heavy_check_mark: | N/A | | `filename` | *string* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | | `mimeType` | *string* | :heavy_check_mark: | N/A | | `sizeBytes` | *number* | :heavy_check_mark: | N/A | -| `type` | [models.AnthropicFileType](../models/anthropicfiletype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.AnthropicFileType](../models/anthropicfiletype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/anthropicfiledeleted.mdx b/docs/models/anthropicfiledeleted.mdx index a00d25863..02afd137e 100644 --- a/docs/models/anthropicfiledeleted.mdx +++ b/docs/models/anthropicfiledeleted.mdx @@ -22,4 +22,4 @@ let value: AnthropicFileDeleted = { | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | | `shape` | *"anthropic"* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.AnthropicFileDeletedType](../models/anthropicfiledeletedtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.AnthropicFileDeletedType](../models/anthropicfiledeletedtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/anthropicfilelist.mdx b/docs/models/anthropicfilelist.mdx index 0f528f18b..a1217d6cb 100644 --- a/docs/models/anthropicfilelist.mdx +++ b/docs/models/anthropicfilelist.mdx @@ -23,7 +23,7 @@ let value: AnthropicFileList = { | Field | Type | Required | Description | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | | `shape` | *"anthropic"* | :heavy_check_mark: | N/A | -| `data` | [models.AnthropicFile](../models/anthropicfile.mdx)[] | :heavy_check_mark: | N/A | +| `data` | [models.AnthropicFile](../models/anthropicfile)[] | :heavy_check_mark: | N/A | | `firstId` | *string* | :heavy_check_mark: | N/A | | `hasMore` | *boolean* | :heavy_check_mark: | N/A | | `lastId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/anthropicimageblockparam.mdx b/docs/models/anthropicimageblockparam.mdx index 2d955a4c9..87858fd31 100644 --- a/docs/models/anthropicimageblockparam.mdx +++ b/docs/models/anthropicimageblockparam.mdx @@ -21,6 +21,6 @@ let value: AnthropicImageBlockParam = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/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"
} | +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective) | :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` | *models.AnthropicImageBlockParamSource* | :heavy_check_mark: | N/A | | | `type` | *"image"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/anthropicinputtokensclearatleast.mdx b/docs/models/anthropicinputtokensclearatleast.mdx index 4f8793969..eef6ba7df 100644 --- a/docs/models/anthropicinputtokensclearatleast.mdx +++ b/docs/models/anthropicinputtokensclearatleast.mdx @@ -17,5 +17,5 @@ let value: AnthropicInputTokensClearAtLeast = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `type` | [models.AnthropicInputTokensClearAtLeastType](../models/anthropicinputtokensclearatleasttype.mdx) | :heavy_check_mark: | N/A | +| `type` | [models.AnthropicInputTokensClearAtLeastType](../models/anthropicinputtokensclearatleasttype) | :heavy_check_mark: | N/A | | `value` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/anthropicmessageusageiteration.mdx b/docs/models/anthropicmessageusageiteration.mdx index 67ec03d53..a9f9e100c 100644 --- a/docs/models/anthropicmessageusageiteration.mdx +++ b/docs/models/anthropicmessageusageiteration.mdx @@ -16,10 +16,10 @@ let value: AnthropicMessageUsageIteration = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `cacheCreation` | [models.AnthropicIterationCacheCreation](../models/anthropiciterationcachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | +| `cacheCreation` | [models.AnthropicIterationCacheCreation](../models/anthropiciterationcachecreation) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | | `cacheCreationInputTokens` | *number* | :heavy_minus_sign: | N/A | | | `cacheReadInputTokens` | *number* | :heavy_minus_sign: | N/A | | | `inputTokens` | *number* | :heavy_minus_sign: | N/A | | | `outputTokens` | *number* | :heavy_minus_sign: | N/A | | | `model` | *string* | :heavy_minus_sign: | N/A | | -| `type` | [models.AnthropicMessageUsageIterationType](../models/anthropicmessageusageiterationtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `type` | [models.AnthropicMessageUsageIterationType](../models/anthropicmessageusageiterationtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/anthropicplaintextsource.mdx b/docs/models/anthropicplaintextsource.mdx index 0539b7a4a..e7d0a49c2 100644 --- a/docs/models/anthropicplaintextsource.mdx +++ b/docs/models/anthropicplaintextsource.mdx @@ -19,5 +19,5 @@ let value: AnthropicPlainTextSource = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | | `data` | *string* | :heavy_check_mark: | N/A | -| `mediaType` | [models.AnthropicPlainTextSourceMediaType](../models/anthropicplaintextsourcemediatype.mdx) | :heavy_check_mark: | N/A | +| `mediaType` | [models.AnthropicPlainTextSourceMediaType](../models/anthropicplaintextsourcemediatype) | :heavy_check_mark: | N/A | | `type` | *"text"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/anthropicsearchresultblockparam.mdx b/docs/models/anthropicsearchresultblockparam.mdx index 8cdb047a3..8770a9bbb 100644 --- a/docs/models/anthropicsearchresultblockparam.mdx +++ b/docs/models/anthropicsearchresultblockparam.mdx @@ -24,9 +24,9 @@ let value: AnthropicSearchResultBlockParam = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/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` | [models.AnthropicSearchResultBlockParamCitations](../models/anthropicsearchresultblockparamcitations.mdx) | :heavy_minus_sign: | N/A | | -| `content` | [models.AnthropicTextBlockParam](../models/anthropictextblockparam.mdx)[] | :heavy_check_mark: | N/A | | +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective) | :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` | [models.AnthropicSearchResultBlockParamCitations](../models/anthropicsearchresultblockparamcitations) | :heavy_minus_sign: | N/A | | +| `content` | [models.AnthropicTextBlockParam](../models/anthropictextblockparam)[] | :heavy_check_mark: | N/A | | | `source` | *string* | :heavy_check_mark: | N/A | | | `title` | *string* | :heavy_check_mark: | N/A | | | `type` | *"search_result"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/anthropictextblockparam.mdx b/docs/models/anthropictextblockparam.mdx index df34fd1a2..d5d5e5fba 100644 --- a/docs/models/anthropictextblockparam.mdx +++ b/docs/models/anthropictextblockparam.mdx @@ -17,7 +17,7 @@ let value: AnthropicTextBlockParam = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/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"
} | +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective) | :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` | *models.Citation*[] | :heavy_minus_sign: | N/A | | | `text` | *string* | :heavy_check_mark: | N/A | | | `type` | *"text"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/anthropicthinkingturns.mdx b/docs/models/anthropicthinkingturns.mdx index 8667e2a01..8245c1acc 100644 --- a/docs/models/anthropicthinkingturns.mdx +++ b/docs/models/anthropicthinkingturns.mdx @@ -17,5 +17,5 @@ let value: AnthropicThinkingTurns = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `type` | [models.AnthropicThinkingTurnsType](../models/anthropicthinkingturnstype.mdx) | :heavy_check_mark: | N/A | +| `type` | [models.AnthropicThinkingTurnsType](../models/anthropicthinkingturnstype) | :heavy_check_mark: | N/A | | `value` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/anthropictoolsearchtoolbm25.mdx b/docs/models/anthropictoolsearchtoolbm25.mdx index af43eff73..8d013bd95 100644 --- a/docs/models/anthropictoolsearchtoolbm25.mdx +++ b/docs/models/anthropictoolsearchtoolbm25.mdx @@ -17,9 +17,9 @@ let value: AnthropicToolSearchToolBm25 = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allowedCallers` | [models.AnthropicAllowedCallers](../models/anthropicallowedcallers.mdx)[] | :heavy_minus_sign: | N/A | [
"direct"
] | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/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"
} | +| `allowedCallers` | [models.AnthropicAllowedCallers](../models/anthropicallowedcallers)[] | :heavy_minus_sign: | N/A | [
"direct"
] | +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | | `deferLoading` | *boolean* | :heavy_minus_sign: | N/A | | -| `name` | [models.AnthropicToolSearchToolBm25Name](../models/anthropictoolsearchtoolbm25name.mdx) | :heavy_check_mark: | N/A | | +| `name` | [models.AnthropicToolSearchToolBm25Name](../models/anthropictoolsearchtoolbm25name) | :heavy_check_mark: | N/A | | | `strict` | *boolean* | :heavy_minus_sign: | N/A | | -| `type` | [models.AnthropicToolSearchToolBm25Type](../models/anthropictoolsearchtoolbm25type.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `type` | [models.AnthropicToolSearchToolBm25Type](../models/anthropictoolsearchtoolbm25type) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/anthropictoolsearchtoolregex.mdx b/docs/models/anthropictoolsearchtoolregex.mdx index 0d46476a9..d23f1ae53 100644 --- a/docs/models/anthropictoolsearchtoolregex.mdx +++ b/docs/models/anthropictoolsearchtoolregex.mdx @@ -17,9 +17,9 @@ let value: AnthropicToolSearchToolRegex = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allowedCallers` | [models.AnthropicAllowedCallers](../models/anthropicallowedcallers.mdx)[] | :heavy_minus_sign: | N/A | [
"direct"
] | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/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"
} | +| `allowedCallers` | [models.AnthropicAllowedCallers](../models/anthropicallowedcallers)[] | :heavy_minus_sign: | N/A | [
"direct"
] | +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | | `deferLoading` | *boolean* | :heavy_minus_sign: | N/A | | -| `name` | [models.AnthropicToolSearchToolRegexName](../models/anthropictoolsearchtoolregexname.mdx) | :heavy_check_mark: | N/A | | +| `name` | [models.AnthropicToolSearchToolRegexName](../models/anthropictoolsearchtoolregexname) | :heavy_check_mark: | N/A | | | `strict` | *boolean* | :heavy_minus_sign: | N/A | | -| `type` | [models.AnthropicToolSearchToolRegexType](../models/anthropictoolsearchtoolregextype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `type` | [models.AnthropicToolSearchToolRegexType](../models/anthropictoolsearchtoolregextype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/anthropictooluseskeep.mdx b/docs/models/anthropictooluseskeep.mdx index feb528efc..75ef3416e 100644 --- a/docs/models/anthropictooluseskeep.mdx +++ b/docs/models/anthropictooluseskeep.mdx @@ -17,5 +17,5 @@ let value: AnthropicToolUsesKeep = { | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `type` | [models.AnthropicToolUsesKeepType](../models/anthropictooluseskeeptype.mdx) | :heavy_check_mark: | N/A | +| `type` | [models.AnthropicToolUsesKeepType](../models/anthropictooluseskeeptype) | :heavy_check_mark: | N/A | | `value` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/anthropicunknownusageiteration.mdx b/docs/models/anthropicunknownusageiteration.mdx index fa2b03440..0bd20525e 100644 --- a/docs/models/anthropicunknownusageiteration.mdx +++ b/docs/models/anthropicunknownusageiteration.mdx @@ -16,7 +16,7 @@ let value: AnthropicUnknownUsageIteration = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `cacheCreation` | [models.AnthropicIterationCacheCreation](../models/anthropiciterationcachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | +| `cacheCreation` | [models.AnthropicIterationCacheCreation](../models/anthropiciterationcachecreation) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | | `cacheCreationInputTokens` | *number* | :heavy_minus_sign: | N/A | | | `cacheReadInputTokens` | *number* | :heavy_minus_sign: | N/A | | | `inputTokens` | *number* | :heavy_minus_sign: | N/A | | diff --git a/docs/models/anthropicwebsearchresultblockparam.mdx b/docs/models/anthropicwebsearchresultblockparam.mdx index a862a6575..bb5d602d2 100644 --- a/docs/models/anthropicwebsearchresultblockparam.mdx +++ b/docs/models/anthropicwebsearchresultblockparam.mdx @@ -22,5 +22,5 @@ let value: AnthropicWebSearchResultBlockParam = { | `encryptedContent` | *string* | :heavy_check_mark: | N/A | | `pageAge` | *string* | :heavy_minus_sign: | N/A | | `title` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.AnthropicWebSearchResultBlockParamType](../models/anthropicwebsearchresultblockparamtype.mdx) | :heavy_check_mark: | N/A | +| `type` | [models.AnthropicWebSearchResultBlockParamType](../models/anthropicwebsearchresultblockparamtype) | :heavy_check_mark: | N/A | | `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/anthropicwebsearchtooluserlocation.mdx b/docs/models/anthropicwebsearchtooluserlocation.mdx index 6d7fac672..f93cdad4d 100644 --- a/docs/models/anthropicwebsearchtooluserlocation.mdx +++ b/docs/models/anthropicwebsearchtooluserlocation.mdx @@ -20,4 +20,4 @@ let value: AnthropicWebSearchToolUserLocation = { | `country` | *string* | :heavy_minus_sign: | N/A | | `region` | *string* | :heavy_minus_sign: | N/A | | `timezone` | *string* | :heavy_minus_sign: | N/A | -| `type` | [models.AnthropicWebSearchToolUserLocationType](../models/anthropicwebsearchtooluserlocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.AnthropicWebSearchToolUserLocationType](../models/anthropicwebsearchtooluserlocationtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/applypatchcallitem.mdx b/docs/models/applypatchcallitem.mdx index de72aaf7f..22c84463d 100644 --- a/docs/models/applypatchcallitem.mdx +++ b/docs/models/applypatchcallitem.mdx @@ -28,5 +28,5 @@ let value: ApplyPatchCallItem = { | `callId` | *string* | :heavy_check_mark: | N/A | | | `id` | *string* | :heavy_minus_sign: | N/A | | | `operation` | *models.ApplyPatchCallOperation* | :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` | [models.ApplyPatchCallStatus](../models/applypatchcallstatus.mdx) | :heavy_check_mark: | Lifecycle state of an `apply_patch_call` output item. | completed | -| `type` | [models.ApplyPatchCallItemType](../models/applypatchcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `status` | [models.ApplyPatchCallStatus](../models/applypatchcallstatus) | :heavy_check_mark: | Lifecycle state of an `apply_patch_call` output item. | completed | +| `type` | [models.ApplyPatchCallItemType](../models/applypatchcallitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/applypatchcalloutputitem.mdx b/docs/models/applypatchcalloutputitem.mdx index c53ae67eb..48eae77a0 100644 --- a/docs/models/applypatchcalloutputitem.mdx +++ b/docs/models/applypatchcalloutputitem.mdx @@ -23,5 +23,5 @@ let value: ApplyPatchCallOutputItem = { | `callId` | *string* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_minus_sign: | N/A | | `output` | *string* | :heavy_minus_sign: | N/A | -| `status` | [models.ApplyPatchCallOutputItemStatus](../models/applypatchcalloutputitemstatus.mdx) | :heavy_check_mark: | N/A | -| `type` | [models.ApplyPatchCallOutputItemType](../models/applypatchcalloutputitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `status` | [models.ApplyPatchCallOutputItemStatus](../models/applypatchcalloutputitemstatus) | :heavy_check_mark: | N/A | +| `type` | [models.ApplyPatchCallOutputItemType](../models/applypatchcalloutputitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/applypatchservertool.mdx b/docs/models/applypatchservertool.mdx index 09945d14e..28da2ae99 100644 --- a/docs/models/applypatchservertool.mdx +++ b/docs/models/applypatchservertool.mdx @@ -18,4 +18,4 @@ let value: ApplyPatchServerTool = { | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `type` | [models.ApplyPatchServerToolType](../models/applypatchservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.ApplyPatchServerToolType](../models/applypatchservertooltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/applypatchservertoolconfig.mdx b/docs/models/applypatchservertoolconfig.mdx index ef60a7687..23dd1cdd8 100644 --- a/docs/models/applypatchservertoolconfig.mdx +++ b/docs/models/applypatchservertoolconfig.mdx @@ -16,4 +16,4 @@ let value: ApplyPatchServerToolConfig = {}; | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `engine` | [models.ApplyPatchEngineEnum](../models/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` | [models.ApplyPatchEngineEnum](../models/applypatchengineenum) | :heavy_minus_sign: | Which apply_patch engine to use. "auto" (default) uses native passthrough when the endpoint advertises native apply_patch support, otherwise falls back to OpenRouter's HITL validator. "native" forces native passthrough — when the endpoint does not support native, the request falls back to HITL. "openrouter" always runs the HITL validator. Native passthrough streams the diff incrementally via `apply_patch_call_operation_diff.delta` events; HITL buffers the diff for atomic delivery as a single delta. | auto | \ No newline at end of file diff --git a/docs/models/applypatchservertoolopenrouter.mdx b/docs/models/applypatchservertoolopenrouter.mdx index dbce89799..2f12b6844 100644 --- a/docs/models/applypatchservertoolopenrouter.mdx +++ b/docs/models/applypatchservertoolopenrouter.mdx @@ -18,5 +18,5 @@ let value: ApplyPatchServerToolOpenRouter = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `parameters` | [models.ApplyPatchServerToolConfig](../models/applypatchservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:apply_patch server tool | \{
"engine": "auto"
} | -| `type` | [models.ApplyPatchServerToolOpenRouterType](../models/applypatchservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.ApplyPatchServerToolConfig](../models/applypatchservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:apply_patch server tool | \{
"engine": "auto"
} | +| `type` | [models.ApplyPatchServerToolOpenRouterType](../models/applypatchservertoolopenroutertype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/apprankingsresponse.mdx b/docs/models/apprankingsresponse.mdx index 7856c5c8c..b24d14c1d 100644 --- a/docs/models/apprankingsresponse.mdx +++ b/docs/models/apprankingsresponse.mdx @@ -37,5 +37,5 @@ let value: AppRankingsResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [models.AppRankingsItem](../models/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` | [models.RankingsDailyMeta](../models/rankingsdailymeta.mdx) | :heavy_check_mark: | N/A | \{
"as_of": "2026-05-12T02:00:00Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
} | \ No newline at end of file +| `data` | [models.AppRankingsItem](../models/apprankingsitem)[] | :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` | [models.RankingsDailyMeta](../models/rankingsdailymeta) | :heavy_check_mark: | N/A | \{
"as_of": "2026-05-12T02:00:00Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
} | \ No newline at end of file diff --git a/docs/models/architecture.mdx b/docs/models/architecture.mdx index 059b7822a..a59b52438 100644 --- a/docs/models/architecture.mdx +++ b/docs/models/architecture.mdx @@ -26,8 +26,8 @@ let value: Architecture = { | Field | Type | Required | Description | Example | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `inputModalities` | [models.InputModality](../models/inputmodality.mdx)[] | :heavy_check_mark: | Supported input modalities | | -| `instructType` | [models.InstructType](../models/instructtype.mdx) | :heavy_check_mark: | Instruction format type | chatml | +| `inputModalities` | [models.InputModality](../models/inputmodality)[] | :heavy_check_mark: | Supported input modalities | | +| `instructType` | [models.InstructType](../models/instructtype) | :heavy_check_mark: | Instruction format type | chatml | | `modality` | *string* | :heavy_check_mark: | Primary modality of the model | text | -| `outputModalities` | [models.OutputModality](../models/outputmodality.mdx)[] | :heavy_check_mark: | Supported output modalities | | -| `tokenizer` | [models.ModelGroup](../models/modelgroup.mdx) | :heavy_check_mark: | N/A | GPT | \ No newline at end of file +| `outputModalities` | [models.OutputModality](../models/outputmodality)[] | :heavy_check_mark: | Supported output modalities | | +| `tokenizer` | [models.ModelGroup](../models/modelgroup) | :heavy_check_mark: | N/A | GPT | \ No newline at end of file diff --git a/docs/models/autobetarouterplugin.mdx b/docs/models/autobetarouterplugin.mdx index d71d39883..58c9cbf7d 100644 --- a/docs/models/autobetarouterplugin.mdx +++ b/docs/models/autobetarouterplugin.mdx @@ -18,6 +18,6 @@ let value: AutoBetaRouterPlugin = { | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `allowedModels` | *string*[] | :heavy_minus_sign: | List of model patterns to filter which models the auto-beta-router can route between. Supports wildcards (e.g., "anthropic/*" matches all Anthropic models). When not specified, uses the default supported models list. | [
"anthropic/*",
"openai/gpt-4o",
"google/*"
] | | ~~`costQualityTradeoff`~~ | *number* | :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. Numeric cost_quality_tradeoff remains supported, retains ceiling behavior, and takes precedence over cost_tier when both are provided. | 9 | -| `costTier` | [models.AutoBetaRouterPluginCostTier](../models/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]. Numeric cost_quality_tradeoff takes precedence and retains ceiling behavior. | low | +| `costTier` | [models.AutoBetaRouterPluginCostTier](../models/autobetarouterplugincosttier) | :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]. Numeric cost_quality_tradeoff takes precedence and retains ceiling behavior. | low | | `enabled` | *boolean* | :heavy_minus_sign: | Set to false to disable the auto-beta-router plugin for this request. Defaults to true. | | | `id` | *"auto-beta-router"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/autorouterplugin.mdx b/docs/models/autorouterplugin.mdx index f7450f95d..b8b7ed457 100644 --- a/docs/models/autorouterplugin.mdx +++ b/docs/models/autorouterplugin.mdx @@ -18,7 +18,7 @@ let value: AutoRouterPlugin = { | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `allowedModels` | *string*[] | :heavy_minus_sign: | List of model patterns to filter which models the auto-router can route between. Supports wildcards (e.g., "anthropic/*" matches all Anthropic models). When not specified, uses the default supported models list. | [
"anthropic/*",
"openai/gpt-4o",
"google/*"
] | | ~~`costQualityTradeoff`~~ | *number* | :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. Controls cost vs. quality routing tradeoff (0–10). 0 = pure quality (best model regardless of cost), 10 = maximize for cost (cheapest model wins). Intermediate values blend quality and cost signals continuously. Defaults to 7. Numeric cost_quality_tradeoff remains supported and takes precedence over cost_tier when both are provided. | 7 | -| `costTier` | [models.AutoRouterPluginCostTier](../models/autorouterplugincosttier.mdx) | :heavy_minus_sign: | Shorthand for cost_quality_tradeoff. Higher tiers spend more on better models: low = 9, medium = 7, high = 5, xhigh = 3, and max = 1. Numeric cost_quality_tradeoff takes precedence when both are provided. | medium | +| `costTier` | [models.AutoRouterPluginCostTier](../models/autorouterplugincosttier) | :heavy_minus_sign: | Shorthand for cost_quality_tradeoff. Higher tiers spend more on better models: low = 9, medium = 7, high = 5, xhigh = 3, and max = 1. Numeric cost_quality_tradeoff takes precedence when both are provided. | medium | | `enabled` | *boolean* | :heavy_minus_sign: | Set to false to disable the auto-router plugin for this request. Defaults to true. | | | `id` | *"auto-router"* | :heavy_check_mark: | N/A | | | `pinModel` | *boolean* | :heavy_minus_sign: | When true, reuses the model from the most recent assistant message's `model` attribute for subsequent turns. Defaults to false. | false | \ No newline at end of file diff --git a/docs/models/baseinputsmessage.mdx b/docs/models/baseinputsmessage.mdx index 038c4cf43..1bebaa34f 100644 --- a/docs/models/baseinputsmessage.mdx +++ b/docs/models/baseinputsmessage.mdx @@ -20,4 +20,4 @@ let value: BaseInputsMessage = { | `content` | *models.BaseInputsContent2* | :heavy_check_mark: | N/A | | `phase` | *models.BaseInputsPhaseUnion* | :heavy_minus_sign: | N/A | | `role` | *models.BaseInputsRoleUnion* | :heavy_check_mark: | N/A | -| `type` | [models.BaseInputsType](../models/baseinputstype.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | [models.BaseInputsType](../models/baseinputstype) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/basereasoningconfig.mdx b/docs/models/basereasoningconfig.mdx index c5afabb00..91bfeceb1 100644 --- a/docs/models/basereasoningconfig.mdx +++ b/docs/models/basereasoningconfig.mdx @@ -14,7 +14,7 @@ let value: BaseReasoningConfig = {}; | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `context` | [models.ReasoningContext](../models/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` | [models.ReasoningEffort](../models/reasoningeffort.mdx) | :heavy_minus_sign: | N/A | medium | -| `mode` | [models.ReasoningMode](../models/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` | [models.ReasoningSummaryVerbosity](../models/reasoningsummaryverbosity.mdx) | :heavy_minus_sign: | N/A | auto | \ No newline at end of file +| `context` | [models.ReasoningContext](../models/reasoningcontext) | :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` | [models.ReasoningEffort](../models/reasoningeffort) | :heavy_minus_sign: | N/A | medium | +| `mode` | [models.ReasoningMode](../models/reasoningmode) | :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` | [models.ReasoningSummaryVerbosity](../models/reasoningsummaryverbosity) | :heavy_minus_sign: | N/A | auto | \ No newline at end of file diff --git a/docs/models/bashservertool.mdx b/docs/models/bashservertool.mdx index 1bee23e8f..b37c979b3 100644 --- a/docs/models/bashservertool.mdx +++ b/docs/models/bashservertool.mdx @@ -18,5 +18,5 @@ let value: BashServerTool = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `parameters` | [models.BashServerToolConfig](../models/bashservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:bash server tool | \{
"environment": \{
"type": "container_auto"
}
} | -| `type` | [models.BashServerToolType](../models/bashservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.BashServerToolConfig](../models/bashservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:bash server tool | \{
"environment": \{
"type": "container_auto"
}
} | +| `type` | [models.BashServerToolType](../models/bashservertooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/bashservertoolconfig.mdx b/docs/models/bashservertoolconfig.mdx index 1d952ff76..738e1cabf 100644 --- a/docs/models/bashservertoolconfig.mdx +++ b/docs/models/bashservertoolconfig.mdx @@ -16,6 +16,6 @@ let value: BashServerToolConfig = {}; | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `engine` | [models.BashServerToolEngine](../models/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 | +| `engine` | [models.BashServerToolEngine](../models/bashservertoolengine) | :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` | *models.BashServerToolEnvironment* | :heavy_minus_sign: | Execution environment for the bash server tool. | \{
"type": "container_auto"
} | | `sleepAfterSeconds` | *number* | :heavy_minus_sign: | How long (in seconds) the container stays warm after its last command before sleeping, freeing its capacity slot. Idle-based: each command renews the timer. Defaults to 900 (15 minutes); capped at 2592000 (30 days). | 900 | \ No newline at end of file diff --git a/docs/models/bulkaddworkspacemembersresponse.mdx b/docs/models/bulkaddworkspacemembersresponse.mdx index 228e96d80..c3c374f94 100644 --- a/docs/models/bulkaddworkspacemembersresponse.mdx +++ b/docs/models/bulkaddworkspacemembersresponse.mdx @@ -26,4 +26,4 @@ let value: BulkAddWorkspaceMembersResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | | `addedCount` | *number* | :heavy_check_mark: | Number of workspace memberships created or updated | 2 | -| `data` | [models.WorkspaceMember](../models/workspacemember.mdx)[] | :heavy_check_mark: | List of added workspace memberships | | \ No newline at end of file +| `data` | [models.WorkspaceMember](../models/workspacemember)[] | :heavy_check_mark: | List of added workspace memberships | | \ No newline at end of file diff --git a/docs/models/byokkey.mdx b/docs/models/byokkey.mdx index 166e682a3..6644b2c14 100644 --- a/docs/models/byokkey.mdx +++ b/docs/models/byokkey.mdx @@ -35,6 +35,6 @@ let value: BYOKKey = { | `isFallback` | *boolean* | :heavy_check_mark: | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. | false | | `label` | *string* | :heavy_check_mark: | Short masked snippet of the key (e.g. the first/last few characters) used to identify it in the UI. | sk-...AbCd | | `name` | *string* | :heavy_minus_sign: | Optional human-readable name for the credential. | Production OpenAI Key | -| `provider` | [models.BYOKProviderSlug](../models/byokproviderslug.mdx) | :heavy_check_mark: | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | +| `provider` | [models.BYOKProviderSlug](../models/byokproviderslug) | :heavy_check_mark: | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | | `sortOrder` | *number* | :heavy_check_mark: | Position within the provider — credentials are tried in ascending sort order. | 0 | | `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this credential belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/chatassistantimages.mdx b/docs/models/chatassistantimages.mdx index f9b051022..617c33579 100644 --- a/docs/models/chatassistantimages.mdx +++ b/docs/models/chatassistantimages.mdx @@ -18,4 +18,4 @@ let value: ChatAssistantImages = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `imageUrl` | [models.ChatAssistantImagesImageUrl](../models/chatassistantimagesimageurl.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `imageUrl` | [models.ChatAssistantImagesImageUrl](../models/chatassistantimagesimageurl) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/chatassistantmessage.mdx b/docs/models/chatassistantmessage.mdx index d2ec5b1e0..f6f6ab8e0 100644 --- a/docs/models/chatassistantmessage.mdx +++ b/docs/models/chatassistantmessage.mdx @@ -18,13 +18,13 @@ let value: ChatAssistantMessage = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `audio` | [models.ChatAudioOutput](../models/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?"
} | +| `audio` | [models.ChatAudioOutput](../models/chataudiooutput) | :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` | *models.ChatAssistantMessageContent* | :heavy_minus_sign: | Assistant message content | | -| `images` | [models.ChatAssistantImages](../models/chatassistantimages.mdx)[] | :heavy_minus_sign: | Generated images from image generation models | [
\{
"image_url": \{
"url": "data:image/png;base64,iVBORw0KGgo..."
}
}
] | +| `images` | [models.ChatAssistantImages](../models/chatassistantimages)[] | :heavy_minus_sign: | Generated images from image generation models | [
\{
"image_url": \{
"url": "data:image/png;base64,iVBORw0KGgo..."
}
}
] | | `model` | *string* | :heavy_minus_sign: | Model that generated this assistant message | openai/gpt-4o | | `name` | *string* | :heavy_minus_sign: | Optional name for the assistant | | | `reasoning` | *string* | :heavy_minus_sign: | Reasoning output | | | `reasoningDetails` | *models.ReasoningDetailUnion*[] | :heavy_minus_sign: | Reasoning details for extended thinking models | [
\{
"text": "Let me work through this step by step...",
"type": "reasoning.text"
}
] | | `refusal` | *string* | :heavy_minus_sign: | Refusal message if content was refused | | -| `role` | [models.ChatAssistantMessageRole](../models/chatassistantmessagerole.mdx) | :heavy_check_mark: | N/A | | -| `toolCalls` | [models.ChatToolCall](../models/chattoolcall.mdx)[] | :heavy_minus_sign: | Tool calls made by the assistant | | \ No newline at end of file +| `role` | [models.ChatAssistantMessageRole](../models/chatassistantmessagerole) | :heavy_check_mark: | N/A | | +| `toolCalls` | [models.ChatToolCall](../models/chattoolcall)[] | :heavy_minus_sign: | Tool calls made by the assistant | | \ No newline at end of file diff --git a/docs/models/chatchoice.mdx b/docs/models/chatchoice.mdx index c8ced91ab..641d0507a 100644 --- a/docs/models/chatchoice.mdx +++ b/docs/models/chatchoice.mdx @@ -22,7 +22,7 @@ let value: ChatChoice = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `finishReason` | [models.ChatFinishReasonEnum](../models/chatfinishreasonenum.mdx) | :heavy_check_mark: | N/A | stop | +| `finishReason` | [models.ChatFinishReasonEnum](../models/chatfinishreasonenum) | :heavy_check_mark: | N/A | stop | | `index` | *number* | :heavy_check_mark: | Choice index | 0 | -| `logprobs` | [models.ChatTokenLogprobs](../models/chattokenlogprobs.mdx) | :heavy_minus_sign: | Log probabilities for the completion | \{
"content": [
\{
"bytes": null,
"logprob": -0.612345,
"token": " Hello",
"top_logprobs": []
}
],
"refusal": null
} | -| `message` | [models.ChatAssistantMessage](../models/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 +| `logprobs` | [models.ChatTokenLogprobs](../models/chattokenlogprobs) | :heavy_minus_sign: | Log probabilities for the completion | \{
"content": [
\{
"bytes": null,
"logprob": -0.612345,
"token": " Hello",
"top_logprobs": []
}
],
"refusal": null
} | +| `message` | [models.ChatAssistantMessage](../models/chatassistantmessage) | :heavy_check_mark: | Assistant message for requests and responses | \{
"content": "What is the capital of France?",
"role": "user"
} | \ No newline at end of file diff --git a/docs/models/chatcontentaudio.mdx b/docs/models/chatcontentaudio.mdx index 44a3473a7..704d4e31a 100644 --- a/docs/models/chatcontentaudio.mdx +++ b/docs/models/chatcontentaudio.mdx @@ -22,5 +22,5 @@ let value: ChatContentAudio = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `inputAudio` | [models.ChatContentAudioInputAudio](../models/chatcontentaudioinputaudio.mdx) | :heavy_check_mark: | N/A | +| `inputAudio` | [models.ChatContentAudioInputAudio](../models/chatcontentaudioinputaudio) | :heavy_check_mark: | N/A | | `type` | *"input_audio"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/chatcontentcachecontrol.mdx b/docs/models/chatcontentcachecontrol.mdx index a365a735d..8c4121233 100644 --- a/docs/models/chatcontentcachecontrol.mdx +++ b/docs/models/chatcontentcachecontrol.mdx @@ -18,5 +18,5 @@ let value: ChatContentCacheControl = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `ttl` | [models.AnthropicCacheControlTtl](../models/anthropiccachecontrolttl.mdx) | :heavy_minus_sign: | N/A | 5m | -| `type` | [models.ChatContentCacheControlType](../models/chatcontentcachecontroltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ttl` | [models.AnthropicCacheControlTtl](../models/anthropiccachecontrolttl) | :heavy_minus_sign: | N/A | 5m | +| `type` | [models.ChatContentCacheControlType](../models/chatcontentcachecontroltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/chatcontentfile.mdx b/docs/models/chatcontentfile.mdx index f10db396f..04e47d7b8 100644 --- a/docs/models/chatcontentfile.mdx +++ b/docs/models/chatcontentfile.mdx @@ -19,5 +19,5 @@ let value: ChatContentFile = { | Field | Type | Required | Description | | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | -| `file` | [models.FileT](../models/filet.mdx) | :heavy_check_mark: | N/A | +| `file` | [models.FileT](../models/filet) | :heavy_check_mark: | N/A | | `type` | *"file"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/chatcontentimage.mdx b/docs/models/chatcontentimage.mdx index d774cf20a..e612d988f 100644 --- a/docs/models/chatcontentimage.mdx +++ b/docs/models/chatcontentimage.mdx @@ -21,5 +21,5 @@ let value: ChatContentImage = { | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `imageUrl` | [models.ChatContentImageImageUrl](../models/chatcontentimageimageurl.mdx) | :heavy_check_mark: | N/A | +| `imageUrl` | [models.ChatContentImageImageUrl](../models/chatcontentimageimageurl) | :heavy_check_mark: | N/A | | `type` | *"image_url"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/chatcontentimageimageurl.mdx b/docs/models/chatcontentimageimageurl.mdx index c958da3a1..fa963b705 100644 --- a/docs/models/chatcontentimageimageurl.mdx +++ b/docs/models/chatcontentimageimageurl.mdx @@ -16,5 +16,5 @@ let value: ChatContentImageImageUrl = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `detail` | [models.ChatContentImageDetail](../models/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. | +| `detail` | [models.ChatContentImageDetail](../models/chatcontentimagedetail) | :heavy_minus_sign: | Image detail level for vision models. `original` is an OpenRouter extension (not in the OpenAI Chat Completions spec) requesting true original-resolution media; it is downgraded to `high` for providers that lack an original-resolution tier. | | `url` | *string* | :heavy_check_mark: | URL of the image (data: URLs supported) | \ No newline at end of file diff --git a/docs/models/chatcontenttext.mdx b/docs/models/chatcontenttext.mdx index df6deebcd..72af921ab 100644 --- a/docs/models/chatcontenttext.mdx +++ b/docs/models/chatcontenttext.mdx @@ -19,7 +19,7 @@ let value: ChatContentText = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cacheControl` | [models.ChatContentCacheControl](../models/chatcontentcachecontrol.mdx) | :heavy_minus_sign: | Anthropic-style cache breakpoint for the content part. Interchangeable with the OpenAI-style `prompt_cache_breakpoint` marker: OpenRouter converts between the two based on the provider serving the request. | \{
"ttl": "5m",
"type": "ephemeral"
} | -| `promptCacheBreakpoint` | [models.PromptCacheBreakpoint](../models/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"
} | +| `cacheControl` | [models.ChatContentCacheControl](../models/chatcontentcachecontrol) | :heavy_minus_sign: | Anthropic-style cache breakpoint for the content part. Interchangeable with the OpenAI-style `prompt_cache_breakpoint` marker: OpenRouter converts between the two based on the provider serving the request. | \{
"ttl": "5m",
"type": "ephemeral"
} | +| `promptCacheBreakpoint` | [models.PromptCacheBreakpoint](../models/promptcachebreakpoint) | :heavy_minus_sign: | Marks an explicit prompt-cache boundary on this content block (OpenAI-style). Everything through the block carrying this marker is part of the candidate cached prefix. Supported natively by OpenAI GPT-5.6 and newer; on providers that use Anthropic-style `cache_control`, OpenRouter converts the marker to that format automatically. | \{
"mode": "explicit"
} | | `text` | *string* | :heavy_check_mark: | N/A | | -| `type` | [models.ChatContentTextType](../models/chatcontenttexttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `type` | [models.ChatContentTextType](../models/chatcontenttexttype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/chatcontentvideo.mdx b/docs/models/chatcontentvideo.mdx index d15db7808..478804fda 100644 --- a/docs/models/chatcontentvideo.mdx +++ b/docs/models/chatcontentvideo.mdx @@ -22,4 +22,4 @@ let value: ChatContentVideo = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | | `type` | *"video_url"* | :heavy_check_mark: | N/A | | -| `videoUrl` | [models.ChatContentVideoInput](../models/chatcontentvideoinput.mdx) | :heavy_check_mark: | Video input object | \{
"url": "https://example.com/video.mp4"
} | \ No newline at end of file +| `videoUrl` | [models.ChatContentVideoInput](../models/chatcontentvideoinput) | :heavy_check_mark: | Video input object | \{
"url": "https://example.com/video.mp4"
} | \ No newline at end of file diff --git a/docs/models/chatformatjsonschemaconfig.mdx b/docs/models/chatformatjsonschemaconfig.mdx index c803fdecf..a4472ca8e 100644 --- a/docs/models/chatformatjsonschemaconfig.mdx +++ b/docs/models/chatformatjsonschemaconfig.mdx @@ -21,5 +21,5 @@ let value: ChatFormatJsonSchemaConfig = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `jsonSchema` | [models.ChatJsonSchemaConfig](../models/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
} | +| `jsonSchema` | [models.ChatJsonSchemaConfig](../models/chatjsonschemaconfig) | :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` | *"json_schema"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/chatfunctiontoolfunction.mdx b/docs/models/chatfunctiontoolfunction.mdx index d7d0bc5a8..5ff76396b 100644 --- a/docs/models/chatfunctiontoolfunction.mdx +++ b/docs/models/chatfunctiontoolfunction.mdx @@ -19,6 +19,6 @@ let value: ChatFunctionToolFunction = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cacheControl` | [models.ChatContentCacheControl](../models/chatcontentcachecontrol.mdx) | :heavy_minus_sign: | Anthropic-style cache breakpoint for the content part. Interchangeable with the OpenAI-style `prompt_cache_breakpoint` marker: OpenRouter converts between the two based on the provider serving the request. | \{
"ttl": "5m",
"type": "ephemeral"
} | -| `function` | [models.ChatFunctionToolFunctionFunction](../models/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` | [models.ChatFunctionToolType](../models/chatfunctiontooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cacheControl` | [models.ChatContentCacheControl](../models/chatcontentcachecontrol) | :heavy_minus_sign: | Anthropic-style cache breakpoint for the content part. Interchangeable with the OpenAI-style `prompt_cache_breakpoint` marker: OpenRouter converts between the two based on the provider serving the request. | \{
"ttl": "5m",
"type": "ephemeral"
} | +| `function` | [models.ChatFunctionToolFunctionFunction](../models/chatfunctiontoolfunctionfunction) | :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` | [models.ChatFunctionToolType](../models/chatfunctiontooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/chatnamedtoolchoice.mdx b/docs/models/chatnamedtoolchoice.mdx index b314de24f..7373bc583 100644 --- a/docs/models/chatnamedtoolchoice.mdx +++ b/docs/models/chatnamedtoolchoice.mdx @@ -21,5 +21,5 @@ let value: ChatNamedToolChoice = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `function` | [models.ChatNamedToolChoiceFunction](../models/chatnamedtoolchoicefunction.mdx) | :heavy_check_mark: | N/A | -| `type` | [models.ChatNamedToolChoiceType](../models/chatnamedtoolchoicetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `function` | [models.ChatNamedToolChoiceFunction](../models/chatnamedtoolchoicefunction) | :heavy_check_mark: | N/A | +| `type` | [models.ChatNamedToolChoiceType](../models/chatnamedtoolchoicetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/chatrequest.mdx b/docs/models/chatrequest.mdx index 800b890dc..ed159978b 100644 --- a/docs/models/chatrequest.mdx +++ b/docs/models/chatrequest.mdx @@ -27,8 +27,8 @@ let value: ChatRequest = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/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` | [models.ChatDebugOptions](../models/chatdebugoptions.mdx) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective) | :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` | [models.ChatDebugOptions](../models/chatdebugoptions) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | | `frequencyPenalty` | *number* | :heavy_minus_sign: | Frequency penalty (-2.0 to 2.0) | 0 | | `imageConfig` | Record\ | :heavy_minus_sign: | Provider-specific image configuration options. Keys and values vary by model/provider. See https://openrouter.ai/docs/guides/overview/multimodal/image-generation for more details. | \{
"aspect_ratio": "16:9",
"quality": "high"
} | | `logitBias` | Record\ | :heavy_minus_sign: | Token logit bias adjustments | \{
"50256": -100
} | @@ -38,27 +38,27 @@ let value: ChatRequest = { | `messages` | *models.ChatMessages*[] | :heavy_check_mark: | List of messages for the conversation | [
\{
"content": "Hello!",
"role": "user"
}
] | | `metadata` | Record\ | :heavy_minus_sign: | Key-value pairs for additional object information (max 16 pairs, 64 char keys, 512 char values) | \{
"session_id": "session-456",
"user_id": "user-123"
} | | `minP` | *number* | :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` | [models.Modality](../models/modality.mdx)[] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text", "image", and "audio". | [
"text",
"image"
] | +| `modalities` | [models.Modality](../models/modality)[] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text", "image", and "audio". | [
"text",
"image"
] | | `model` | *string* | :heavy_minus_sign: | Model to use for completion | openai/gpt-4 | | `models` | *string*[] | :heavy_minus_sign: | Models to use for completion | [
"openai/gpt-4",
"openai/gpt-4o"
] | | `parallelToolCalls` | *boolean* | :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` | *models.ChatRequestPlugin*[] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `prediction` | [models.Prediction](../models/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"
} | +| `prediction` | [models.Prediction](../models/prediction) | :heavy_minus_sign: | Static predicted output content. Supported models can use this to reduce latency when much of the response is known in advance. | \{
"content": "Expected response",
"type": "content"
} | | `presencePenalty` | *number* | :heavy_minus_sign: | Presence penalty (-2.0 to 2.0) | 0 | | `promptCacheKey` | *string* | :heavy_minus_sign: | N/A | | -| `promptCacheOptions` | [models.PromptCacheOptions](../models/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` | [models.ProviderPreferences](../models/providerpreferences.mdx) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `reasoning` | [models.ChatRequestReasoning](../models/chatrequestreasoning.mdx) | :heavy_minus_sign: | Configuration options for reasoning models | \{
"effort": "medium",
"summary": "concise"
} | -| `reasoningEffort` | [models.ChatRequestReasoningEffort](../models/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 | +| `promptCacheOptions` | [models.PromptCacheOptions](../models/promptcacheoptions) | :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` | [models.ProviderPreferences](../models/providerpreferences) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `reasoning` | [models.ChatRequestReasoning](../models/chatrequestreasoning) | :heavy_minus_sign: | Configuration options for reasoning models | \{
"effort": "medium",
"summary": "concise"
} | +| `reasoningEffort` | [models.ChatRequestReasoningEffort](../models/chatrequestreasoningeffort) | :heavy_minus_sign: | Shorthand for setting reasoning effort. Equivalent to setting reasoning.effort. Cannot be used simultaneously with reasoning.effort if they differ. | medium | | `repetitionPenalty` | *number* | :heavy_minus_sign: | Penalizes tokens based on how much they have already appeared in the text. A value of 1.0 means no penalty. Values above 1.0 penalize repeated tokens more strongly. Not all providers support this parameter. | 1 | | `responseFormat` | *models.ResponseFormat* | :heavy_minus_sign: | Response format configuration | \{
"type": "json_object"
} | | `seed` | *number* | :heavy_minus_sign: | Random seed for deterministic outputs | 42 | -| `serviceTier` | [models.ChatRequestServiceTier](../models/chatrequestservicetier.mdx) | :heavy_minus_sign: | The service tier to use for processing this request. | auto | +| `serviceTier` | [models.ChatRequestServiceTier](../models/chatrequestservicetier) | :heavy_minus_sign: | The service tier to use for processing this request. | auto | | `sessionId` | *string* | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). When provided, OpenRouter uses it as the sticky routing key, routing all requests in the session to the same provider to maximize prompt cache hits. Also used for observability grouping. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | | | `stop` | *models.Stop* | :heavy_minus_sign: | Stop sequences (up to 4) | [
"\n"
] | | `stopServerToolsWhen` | *models.StopServerToolsWhenCondition*[] | :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` | *boolean* | :heavy_minus_sign: | Enable streaming response | false | -| `streamOptions` | [models.ChatStreamOptions](../models/chatstreamoptions.mdx) | :heavy_minus_sign: | Streaming configuration options | \{
"include_usage": true
} | +| `streamOptions` | [models.ChatStreamOptions](../models/chatstreamoptions) | :heavy_minus_sign: | Streaming configuration options | \{
"include_usage": true
} | | `temperature` | *number* | :heavy_minus_sign: | Sampling temperature (0-2) | 0.7 | | `toolChoice` | *models.ChatToolChoice* | :heavy_minus_sign: | Tool choice configuration | auto | | `tools` | *models.ChatFunctionTool*[] | :heavy_minus_sign: | Available tools for function calling | [
\{
"function": \{
"description": "Get weather",
"name": "get_weather"
},
"type": "function"
}
] | @@ -66,5 +66,5 @@ let value: ChatRequest = { | `topK` | *number* | :heavy_minus_sign: | Limits the model to choose from the top K most likely tokens at each step. A value of 1 means the model will always pick the most likely next token. Not all providers support this parameter. | 40 | | `topLogprobs` | *number* | :heavy_minus_sign: | Number of top log probabilities to return (0-20) | 5 | | `topP` | *number* | :heavy_minus_sign: | Nucleus sampling parameter (0-1) | 1 | -| `trace` | [models.TraceConfig](../models/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"
} | +| `trace` | [models.TraceConfig](../models/traceconfig) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | | `user` | *string* | :heavy_minus_sign: | Per-end-user identifier for abuse isolation. Use a stable ID, hash, or pseudonym. When a provider requires a user identity, OpenRouter folds it into the hashed identity sent upstream and never forwards it raw. If omitted, requests use an account-level identity, so provider policy blocks can affect the whole account. | user-123 | \ No newline at end of file diff --git a/docs/models/chatrequestreasoning.mdx b/docs/models/chatrequestreasoning.mdx index 42ca90f24..2381251d4 100644 --- a/docs/models/chatrequestreasoning.mdx +++ b/docs/models/chatrequestreasoning.mdx @@ -16,5 +16,5 @@ let value: ChatRequestReasoning = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `effort` | [models.ChatRequestEffort](../models/chatrequesteffort.mdx) | :heavy_minus_sign: | Constrains effort on reasoning for reasoning models | medium | -| `summary` | [models.ChatReasoningSummaryVerbosityEnum](../models/chatreasoningsummaryverbosityenum.mdx) | :heavy_minus_sign: | N/A | concise | \ No newline at end of file +| `effort` | [models.ChatRequestEffort](../models/chatrequesteffort) | :heavy_minus_sign: | Constrains effort on reasoning for reasoning models | medium | +| `summary` | [models.ChatReasoningSummaryVerbosityEnum](../models/chatreasoningsummaryverbosityenum) | :heavy_minus_sign: | N/A | concise | \ No newline at end of file diff --git a/docs/models/chatresult.mdx b/docs/models/chatresult.mdx index 3dc4c3308..7971912a6 100644 --- a/docs/models/chatresult.mdx +++ b/docs/models/chatresult.mdx @@ -31,12 +31,12 @@ let value: ChatResult = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `choices` | [models.ChatChoice](../models/chatchoice.mdx)[] | :heavy_check_mark: | List of completion choices | | +| `choices` | [models.ChatChoice](../models/chatchoice)[] | :heavy_check_mark: | List of completion choices | | | `created` | *number* | :heavy_check_mark: | Unix timestamp of creation | 1677652288 | | `id` | *string* | :heavy_check_mark: | Unique completion identifier | chatcmpl-123 | | `model` | *string* | :heavy_check_mark: | Model used for completion | openai/gpt-4 | -| `object` | [models.ChatResultObject](../models/chatresultobject.mdx) | :heavy_check_mark: | N/A | | -| `openrouterMetadata` | [models.OpenRouterMetadata](../models/openroutermetadata.mdx) | :heavy_minus_sign: | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | +| `object` | [models.ChatResultObject](../models/chatresultobject) | :heavy_check_mark: | N/A | | +| `openrouterMetadata` | [models.OpenRouterMetadata](../models/openroutermetadata) | :heavy_minus_sign: | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | | `serviceTier` | *string* | :heavy_minus_sign: | The service tier used by the upstream provider for this request | default | | `systemFingerprint` | *string* | :heavy_check_mark: | System fingerprint | fp_44709d6fcb | -| `usage` | [models.ChatUsage](../models/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 +| `usage` | [models.ChatUsage](../models/chatusage) | :heavy_minus_sign: | Token usage statistics | \{
"completion_tokens": 15,
"completion_tokens_details": \{
"reasoning_tokens": 5
},
"cost": 0.0012,
"cost_details": \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
},
"is_byok": false,
"prompt_tokens": 10,
"prompt_tokens_details": \{
"cached_tokens": 2
},
"server_tool_use_details": \{
"tool_calls_executed": 2,
"tool_calls_requested": 2
},
"total_tokens": 25
} | \ No newline at end of file diff --git a/docs/models/chatsearchmodelsservertool.mdx b/docs/models/chatsearchmodelsservertool.mdx index 93b1f3ec3..518d3ed3f 100644 --- a/docs/models/chatsearchmodelsservertool.mdx +++ b/docs/models/chatsearchmodelsservertool.mdx @@ -18,5 +18,5 @@ let value: ChatSearchModelsServerTool = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `parameters` | [models.SearchModelsServerToolConfig](../models/searchmodelsservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | -| `type` | [models.ChatSearchModelsServerToolType](../models/chatsearchmodelsservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.SearchModelsServerToolConfig](../models/searchmodelsservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | +| `type` | [models.ChatSearchModelsServerToolType](../models/chatsearchmodelsservertooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/chatstreamchoice.mdx b/docs/models/chatstreamchoice.mdx index 7f04eef8a..15ebd7e52 100644 --- a/docs/models/chatstreamchoice.mdx +++ b/docs/models/chatstreamchoice.mdx @@ -20,7 +20,7 @@ let value: ChatStreamChoice = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `delta` | [models.ChatStreamDelta](../models/chatstreamdelta.mdx) | :heavy_check_mark: | Delta changes in streaming response | \{
"content": "Hello",
"role": "assistant"
} | -| `finishReason` | [models.ChatFinishReasonEnum](../models/chatfinishreasonenum.mdx) | :heavy_check_mark: | N/A | stop | +| `delta` | [models.ChatStreamDelta](../models/chatstreamdelta) | :heavy_check_mark: | Delta changes in streaming response | \{
"content": "Hello",
"role": "assistant"
} | +| `finishReason` | [models.ChatFinishReasonEnum](../models/chatfinishreasonenum) | :heavy_check_mark: | N/A | stop | | `index` | *number* | :heavy_check_mark: | Choice index | 0 | -| `logprobs` | [models.ChatTokenLogprobs](../models/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 +| `logprobs` | [models.ChatTokenLogprobs](../models/chattokenlogprobs) | :heavy_minus_sign: | Log probabilities for the completion | \{
"content": [
\{
"bytes": null,
"logprob": -0.612345,
"token": " Hello",
"top_logprobs": []
}
],
"refusal": null
} | \ No newline at end of file diff --git a/docs/models/chatstreamchunk.mdx b/docs/models/chatstreamchunk.mdx index af9cebae9..a9647da9d 100644 --- a/docs/models/chatstreamchunk.mdx +++ b/docs/models/chatstreamchunk.mdx @@ -28,13 +28,13 @@ let value: ChatStreamChunk = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `choices` | [models.ChatStreamChoice](../models/chatstreamchoice.mdx)[] | :heavy_check_mark: | List of streaming chunk choices | | +| `choices` | [models.ChatStreamChoice](../models/chatstreamchoice)[] | :heavy_check_mark: | List of streaming chunk choices | | | `created` | *number* | :heavy_check_mark: | Unix timestamp of creation | 1677652288 | -| `error` | [models.ChatStreamChunkError](../models/chatstreamchunkerror.mdx) | :heavy_minus_sign: | Error information | \{
"code": 429,
"message": "Rate limit exceeded",
"metadata": \{
"error_type": "rate_limit_exceeded"
}
} | +| `error` | [models.ChatStreamChunkError](../models/chatstreamchunkerror) | :heavy_minus_sign: | Error information | \{
"code": 429,
"message": "Rate limit exceeded",
"metadata": \{
"error_type": "rate_limit_exceeded"
}
} | | `id` | *string* | :heavy_check_mark: | Unique chunk identifier | chatcmpl-123 | | `model` | *string* | :heavy_check_mark: | Model used for completion | openai/gpt-4 | -| `object` | [models.ChatStreamChunkObject](../models/chatstreamchunkobject.mdx) | :heavy_check_mark: | N/A | | -| `openrouterMetadata` | [models.OpenRouterMetadata](../models/openroutermetadata.mdx) | :heavy_minus_sign: | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | +| `object` | [models.ChatStreamChunkObject](../models/chatstreamchunkobject) | :heavy_check_mark: | N/A | | +| `openrouterMetadata` | [models.OpenRouterMetadata](../models/openroutermetadata) | :heavy_minus_sign: | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | | `serviceTier` | *string* | :heavy_minus_sign: | The service tier used by the upstream provider for this request | default | | `systemFingerprint` | *string* | :heavy_minus_sign: | System fingerprint | fp_44709d6fcb | -| `usage` | [models.ChatUsage](../models/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 +| `usage` | [models.ChatUsage](../models/chatusage) | :heavy_minus_sign: | Token usage statistics | \{
"completion_tokens": 15,
"completion_tokens_details": \{
"reasoning_tokens": 5
},
"cost": 0.0012,
"cost_details": \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
},
"is_byok": false,
"prompt_tokens": 10,
"prompt_tokens_details": \{
"cached_tokens": 2
},
"server_tool_use_details": \{
"tool_calls_executed": 2,
"tool_calls_requested": 2
},
"total_tokens": 25
} | \ No newline at end of file diff --git a/docs/models/chatstreamchunkerror.mdx b/docs/models/chatstreamchunkerror.mdx index 9d733e369..1a5825ef2 100644 --- a/docs/models/chatstreamchunkerror.mdx +++ b/docs/models/chatstreamchunkerror.mdx @@ -21,4 +21,4 @@ let value: ChatStreamChunkError = { | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | | `code` | *number* | :heavy_check_mark: | Error code | 429 | | `message` | *string* | :heavy_check_mark: | Error message | Rate limit exceeded | -| `metadata` | [models.ChatStreamChunkMetadata](../models/chatstreamchunkmetadata.mdx) | :heavy_minus_sign: | Structured error metadata | | \ No newline at end of file +| `metadata` | [models.ChatStreamChunkMetadata](../models/chatstreamchunkmetadata) | :heavy_minus_sign: | Structured error metadata | | \ No newline at end of file diff --git a/docs/models/chatstreamchunkmetadata.mdx b/docs/models/chatstreamchunkmetadata.mdx index 798c97df0..1f7b9b64e 100644 --- a/docs/models/chatstreamchunkmetadata.mdx +++ b/docs/models/chatstreamchunkmetadata.mdx @@ -18,5 +18,5 @@ let value: ChatStreamChunkMetadata = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `errorType` | [models.ApiErrorType](../models/apierrortype.mdx) | :heavy_check_mark: | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | +| `errorType` | [models.ApiErrorType](../models/apierrortype) | :heavy_check_mark: | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | | `providerCode` | *string* | :heavy_minus_sign: | Upstream provider-specific error code, when available | | \ No newline at end of file diff --git a/docs/models/chatstreamdelta.mdx b/docs/models/chatstreamdelta.mdx index 69b73edc2..3899bdca0 100644 --- a/docs/models/chatstreamdelta.mdx +++ b/docs/models/chatstreamdelta.mdx @@ -16,10 +16,10 @@ let value: ChatStreamDelta = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `audio` | [models.ChatAudioOutput](../models/chataudiooutput.mdx) | :heavy_minus_sign: | N/A | \{
"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f",
"expires_at": 1677652400,
"id": "audio_abc123",
"transcript": "Hello! How can I help you today?"
} | +| `audio` | [models.ChatAudioOutput](../models/chataudiooutput) | :heavy_minus_sign: | N/A | \{
"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f",
"expires_at": 1677652400,
"id": "audio_abc123",
"transcript": "Hello! How can I help you today?"
} | | `content` | *string* | :heavy_minus_sign: | Message content delta | Hello | | `reasoning` | *string* | :heavy_minus_sign: | Reasoning content delta | I need to | | `reasoningDetails` | *models.ReasoningDetailUnion*[] | :heavy_minus_sign: | Reasoning details for extended thinking models | [
\{
"text": "Let me think about this...",
"type": "reasoning.text"
}
] | | `refusal` | *string* | :heavy_minus_sign: | Refusal message delta | null | -| `role` | [models.ChatStreamDeltaRole](../models/chatstreamdeltarole.mdx) | :heavy_minus_sign: | The role of the message author | assistant | -| `toolCalls` | [models.ChatStreamToolCall](../models/chatstreamtoolcall.mdx)[] | :heavy_minus_sign: | Tool calls delta | | \ No newline at end of file +| `role` | [models.ChatStreamDeltaRole](../models/chatstreamdeltarole) | :heavy_minus_sign: | The role of the message author | assistant | +| `toolCalls` | [models.ChatStreamToolCall](../models/chatstreamtoolcall)[] | :heavy_minus_sign: | Tool calls delta | | \ No newline at end of file diff --git a/docs/models/chatstreamingresponse.mdx b/docs/models/chatstreamingresponse.mdx index aba2941c0..7624d47f4 100644 --- a/docs/models/chatstreamingresponse.mdx +++ b/docs/models/chatstreamingresponse.mdx @@ -28,4 +28,4 @@ let value: ChatStreamingResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.ChatStreamChunk](../models/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` | [models.ChatStreamChunk](../models/chatstreamchunk) | :heavy_check_mark: | Streaming chat completion chunk | \{
"choices": [
\{
"delta": \{
"content": "Hello",
"role": "assistant"
},
"finish_reason": null,
"index": 0
}
],
"created": 1677652288,
"id": "chatcmpl-123",
"model": "openai/gpt-4",
"object": "chat.completion.chunk"
} | \ No newline at end of file diff --git a/docs/models/chatstreamtoolcall.mdx b/docs/models/chatstreamtoolcall.mdx index 2f47f0657..af63acdff 100644 --- a/docs/models/chatstreamtoolcall.mdx +++ b/docs/models/chatstreamtoolcall.mdx @@ -18,7 +18,7 @@ let value: ChatStreamToolCall = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `function` | [models.ChatStreamToolCallFunction](../models/chatstreamtoolcallfunction.mdx) | :heavy_minus_sign: | Function call details | | +| `function` | [models.ChatStreamToolCallFunction](../models/chatstreamtoolcallfunction) | :heavy_minus_sign: | Function call details | | | `id` | *string* | :heavy_minus_sign: | Tool call identifier | call_abc123 | | `index` | *number* | :heavy_check_mark: | Tool call index in the array | 0 | -| `type` | [models.ChatStreamToolCallType](../models/chatstreamtoolcalltype.mdx) | :heavy_minus_sign: | Tool call type | function | \ No newline at end of file +| `type` | [models.ChatStreamToolCallType](../models/chatstreamtoolcalltype) | :heavy_minus_sign: | Tool call type | function | \ No newline at end of file diff --git a/docs/models/chattokenlogprob.mdx b/docs/models/chattokenlogprob.mdx index 9f99e4c46..206d13e21 100644 --- a/docs/models/chattokenlogprob.mdx +++ b/docs/models/chattokenlogprob.mdx @@ -30,4 +30,4 @@ let value: ChatTokenLogprob = { | `bytes` | *number*[] | :heavy_check_mark: | UTF-8 bytes of the token | | `logprob` | *number* | :heavy_check_mark: | Log probability of the token | | `token` | *string* | :heavy_check_mark: | The token | -| `topLogprobs` | [models.ChatTokenLogprobTopLogprob](../models/chattokenlogprobtoplogprob.mdx)[] | :heavy_check_mark: | Top alternative tokens with probabilities | \ No newline at end of file +| `topLogprobs` | [models.ChatTokenLogprobTopLogprob](../models/chattokenlogprobtoplogprob)[] | :heavy_check_mark: | Top alternative tokens with probabilities | \ No newline at end of file diff --git a/docs/models/chattokenlogprobs.mdx b/docs/models/chattokenlogprobs.mdx index 11bbf83db..23147a016 100644 --- a/docs/models/chattokenlogprobs.mdx +++ b/docs/models/chattokenlogprobs.mdx @@ -25,5 +25,5 @@ let value: ChatTokenLogprobs = { | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `content` | [models.ChatTokenLogprob](../models/chattokenlogprob.mdx)[] | :heavy_check_mark: | Log probabilities for content tokens | -| `refusal` | [models.ChatTokenLogprob](../models/chattokenlogprob.mdx)[] | :heavy_minus_sign: | Log probabilities for refusal tokens | \ No newline at end of file +| `content` | [models.ChatTokenLogprob](../models/chattokenlogprob)[] | :heavy_check_mark: | Log probabilities for content tokens | +| `refusal` | [models.ChatTokenLogprob](../models/chattokenlogprob)[] | :heavy_minus_sign: | Log probabilities for refusal tokens | \ No newline at end of file diff --git a/docs/models/chattoolcall.mdx b/docs/models/chattoolcall.mdx index 174621eab..97e1c09eb 100644 --- a/docs/models/chattoolcall.mdx +++ b/docs/models/chattoolcall.mdx @@ -23,6 +23,6 @@ let value: ChatToolCall = { | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `function` | [models.ChatToolCallFunction](../models/chattoolcallfunction.mdx) | :heavy_check_mark: | N/A | +| `function` | [models.ChatToolCallFunction](../models/chattoolcallfunction) | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | Tool call identifier | -| `type` | [models.ChatToolCallType](../models/chattoolcalltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.ChatToolCallType](../models/chattoolcalltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/chatusage.mdx b/docs/models/chatusage.mdx index f3b6d7388..b70dc12df 100644 --- a/docs/models/chatusage.mdx +++ b/docs/models/chatusage.mdx @@ -21,11 +21,11 @@ let value: ChatUsage = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `completionTokens` | *number* | :heavy_check_mark: | Number of tokens in the completion | | -| `completionTokensDetails` | [models.ChatUsageCompletionTokensDetails](../models/chatusagecompletiontokensdetails.mdx) | :heavy_minus_sign: | Detailed completion token usage | | +| `completionTokensDetails` | [models.ChatUsageCompletionTokensDetails](../models/chatusagecompletiontokensdetails) | :heavy_minus_sign: | Detailed completion token usage | | | `cost` | *number* | :heavy_minus_sign: | Cost of the completion | | -| `costDetails` | [models.CostDetails](../models/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
} | +| `costDetails` | [models.CostDetails](../models/costdetails) | :heavy_minus_sign: | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | | `isByok` | *boolean* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | | `promptTokens` | *number* | :heavy_check_mark: | Number of tokens in the prompt | | -| `promptTokensDetails` | [models.ChatUsagePromptTokensDetails](../models/chatusageprompttokensdetails.mdx) | :heavy_minus_sign: | Detailed prompt token usage | | -| `serverToolUseDetails` | [models.ServerToolUseDetails](../models/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
} | +| `promptTokensDetails` | [models.ChatUsagePromptTokensDetails](../models/chatusageprompttokensdetails) | :heavy_minus_sign: | Detailed prompt token usage | | +| `serverToolUseDetails` | [models.ServerToolUseDetails](../models/servertoolusedetails) | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | \{
"tool_calls_executed": 2,
"tool_calls_requested": 2,
"web_search_requests": 2
} | | `totalTokens` | *number* | :heavy_check_mark: | Total number of tokens | | \ No newline at end of file diff --git a/docs/models/chatwebsearchshorthand.mdx b/docs/models/chatwebsearchshorthand.mdx index 6286c9fc3..8fbb93414 100644 --- a/docs/models/chatwebsearchshorthand.mdx +++ b/docs/models/chatwebsearchshorthand.mdx @@ -19,13 +19,13 @@ let value: ChatWebSearchShorthand = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `allowedDomains` | *string*[] | :heavy_minus_sign: | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, and most native providers (Anthropic, OpenAI, xAI). Cannot be used with excluded_domains. | | -| `engine` | [models.WebSearchEngineEnum](../models/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 | +| `engine` | [models.WebSearchEngineEnum](../models/websearchengineenum) | :heavy_minus_sign: | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | | `excludedDomains` | *string*[] | :heavy_minus_sign: | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, OpenAI, and xAI. Cannot be used with allowed_domains. | | | `maxCharacters` | *number* | :heavy_minus_sign: | Exact maximum number of characters of content per search result. Applies to the Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, caps highlight content per result. For Parallel, caps excerpt content per result (default 1,500 when omitted). For Perplexity, maps to the native `max_tokens_per_page` parameter (converted from characters to tokens) and trims the response to the exact character cap. When both `max_characters` and `search_context_size` are set, `max_characters` takes precedence. When omitted, falls back to `search_context_size` mapping (Exa) or engine defaults (Parallel, Perplexity). | 2000 | | `maxResults` | *number* | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | | `maxTotalResults` | *number* | :heavy_minus_sign: | Maximum total number of search results across all search calls in a single request. Once this limit is reached, the tool will stop returning new results. Useful for controlling cost and context size in agentic loops. Defaults to 50 when not specified. | 50 | | `maxUses` | *number* | :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 | -| `parameters` | [models.WebSearchConfig](../models/websearchconfig.mdx) | :heavy_minus_sign: | N/A | \{
"max_results": 5,
"search_context_size": "medium"
} | -| `searchContextSize` | [models.SearchQualityLevel](../models/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` | [models.ChatWebSearchShorthandType](../models/chatwebsearchshorthandtype.mdx) | :heavy_check_mark: | N/A | | -| `userLocation` | [models.WebSearchUserLocationServerTool](../models/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"
} | \ No newline at end of file +| `parameters` | [models.WebSearchConfig](../models/websearchconfig) | :heavy_minus_sign: | N/A | \{
"max_results": 5,
"search_context_size": "medium"
} | +| `searchContextSize` | [models.SearchQualityLevel](../models/searchqualitylevel) | :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` | [models.ChatWebSearchShorthandType](../models/chatwebsearchshorthandtype) | :heavy_check_mark: | N/A | | +| `userLocation` | [models.WebSearchUserLocationServerTool](../models/websearchuserlocationservertool) | :heavy_minus_sign: | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file diff --git a/docs/models/codeinterpreterservertool.mdx b/docs/models/codeinterpreterservertool.mdx index e57cb0dc5..305dc5a81 100644 --- a/docs/models/codeinterpreterservertool.mdx +++ b/docs/models/codeinterpreterservertool.mdx @@ -20,4 +20,4 @@ let value: CodeInterpreterServerTool = { | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | | `container` | *models.Container* | :heavy_check_mark: | N/A | -| `type` | [models.TypeCodeInterpreter](../models/typecodeinterpreter.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.TypeCodeInterpreter](../models/typecodeinterpreter) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/codexlocalshelltool.mdx b/docs/models/codexlocalshelltool.mdx index 0d502354c..1218eecce 100644 --- a/docs/models/codexlocalshelltool.mdx +++ b/docs/models/codexlocalshelltool.mdx @@ -18,4 +18,4 @@ let value: CodexLocalShellTool = { | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `type` | [models.CodexLocalShellToolType](../models/codexlocalshelltooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.CodexLocalShellToolType](../models/codexlocalshelltooltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/compactionitem.mdx b/docs/models/compactionitem.mdx index 0f5a2c6d7..1dfaf5da8 100644 --- a/docs/models/compactionitem.mdx +++ b/docs/models/compactionitem.mdx @@ -21,5 +21,5 @@ let value: CompactionItem = { | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | | `encryptedContent` | *string* | :heavy_check_mark: | N/A | | | `id` | *string* | :heavy_minus_sign: | N/A | | -| `type` | [models.CompactionItemType](../models/compactionitemtype.mdx) | :heavy_check_mark: | N/A | | +| `type` | [models.CompactionItemType](../models/compactionitemtype) | :heavy_check_mark: | N/A | | | `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \{
"encrypted_content": "enc_abc123...",
"type": "compaction"
} | \ No newline at end of file diff --git a/docs/models/compoundfilter.mdx b/docs/models/compoundfilter.mdx index dcf2b84e2..57569dd39 100644 --- a/docs/models/compoundfilter.mdx +++ b/docs/models/compoundfilter.mdx @@ -26,4 +26,4 @@ let value: CompoundFilter = { | Field | Type | Required | Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | | `filters` | Record\[] | :heavy_check_mark: | N/A | -| `type` | [models.CompoundFilterType](../models/compoundfiltertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.CompoundFilterType](../models/compoundfiltertype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/computeruseservertool.mdx b/docs/models/computeruseservertool.mdx index ffe1f674f..f74fa4810 100644 --- a/docs/models/computeruseservertool.mdx +++ b/docs/models/computeruseservertool.mdx @@ -23,5 +23,5 @@ let value: ComputerUseServerTool = { | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | | `displayHeight` | *number* | :heavy_check_mark: | N/A | | `displayWidth` | *number* | :heavy_check_mark: | N/A | -| `environment` | [models.Environment](../models/environment.mdx) | :heavy_check_mark: | N/A | -| `type` | [models.ComputerUseServerToolType](../models/computeruseservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `environment` | [models.Environment](../models/environment) | :heavy_check_mark: | N/A | +| `type` | [models.ComputerUseServerToolType](../models/computeruseservertooltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/containerauto.mdx b/docs/models/containerauto.mdx index 6dce69021..b6fe197b8 100644 --- a/docs/models/containerauto.mdx +++ b/docs/models/containerauto.mdx @@ -17,5 +17,5 @@ let value: ContainerAuto = { | Field | Type | Required | Description | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | | `fileIds` | *string*[] | :heavy_minus_sign: | N/A | -| `memoryLimit` | [models.MemoryLimit](../models/memorylimit.mdx) | :heavy_minus_sign: | N/A | -| `type` | [models.ContainerType](../models/containertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `memoryLimit` | [models.MemoryLimit](../models/memorylimit) | :heavy_minus_sign: | N/A | +| `type` | [models.ContainerType](../models/containertype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/contentcompaction.mdx b/docs/models/contentcompaction.mdx index a18ff2acf..4c7aa4156 100644 --- a/docs/models/contentcompaction.mdx +++ b/docs/models/contentcompaction.mdx @@ -17,7 +17,7 @@ let value: ContentCompaction = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/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"
} | +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | | `content` | *string* | :heavy_check_mark: | N/A | | | `encryptedContent` | *string* | :heavy_minus_sign: | N/A | | | `type` | *"compaction"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/contentfilterbuiltinentry.mdx b/docs/models/contentfilterbuiltinentry.mdx index f1d8c2c56..bcc5e3e51 100644 --- a/docs/models/contentfilterbuiltinentry.mdx +++ b/docs/models/contentfilterbuiltinentry.mdx @@ -19,7 +19,7 @@ let value: ContentFilterBuiltinEntry = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `action` | [models.ContentFilterBuiltinAction](../models/contentfilterbuiltinaction.mdx) | :heavy_check_mark: | Action taken when the builtin filter triggers | block | +| `action` | [models.ContentFilterBuiltinAction](../models/contentfilterbuiltinaction) | :heavy_check_mark: | Action taken when the builtin filter triggers | block | | `label` | *string* | :heavy_minus_sign: | Read-only, system-assigned redaction placeholder derived from the slug (e.g. "[EMAIL]", "[PHONE]"). Not settable by the caller. | [EMAIL] | -| `scanScope` | [models.PromptInjectionScanScope](../models/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` | [models.ContentFilterBuiltinSlug](../models/contentfilterbuiltinslug.mdx) | :heavy_check_mark: | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file +| `scanScope` | [models.PromptInjectionScanScope](../models/promptinjectionscanscope) | :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` | [models.ContentFilterBuiltinSlug](../models/contentfilterbuiltinslug) | :heavy_check_mark: | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file diff --git a/docs/models/contentfilterbuiltinentryinput.mdx b/docs/models/contentfilterbuiltinentryinput.mdx index 971e2cbe5..f85f98b39 100644 --- a/docs/models/contentfilterbuiltinentryinput.mdx +++ b/docs/models/contentfilterbuiltinentryinput.mdx @@ -19,7 +19,7 @@ let value: ContentFilterBuiltinEntryInput = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `action` | [models.ContentFilterBuiltinAction](../models/contentfilterbuiltinaction.mdx) | :heavy_check_mark: | Action taken when the builtin filter triggers | block | +| `action` | [models.ContentFilterBuiltinAction](../models/contentfilterbuiltinaction) | :heavy_check_mark: | Action taken when the builtin filter triggers | block | | ~~`label`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: labels are system-assigned and cannot be set by the caller. Accepted for backward compatibility but silently ignored. | | -| `scanScope` | [models.PromptInjectionScanScope](../models/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` | [models.ContentFilterBuiltinSlug](../models/contentfilterbuiltinslug.mdx) | :heavy_check_mark: | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file +| `scanScope` | [models.PromptInjectionScanScope](../models/promptinjectionscanscope) | :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` | [models.ContentFilterBuiltinSlug](../models/contentfilterbuiltinslug) | :heavy_check_mark: | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file diff --git a/docs/models/contentfilterentry.mdx b/docs/models/contentfilterentry.mdx index 658343787..7be2bc42d 100644 --- a/docs/models/contentfilterentry.mdx +++ b/docs/models/contentfilterentry.mdx @@ -19,6 +19,6 @@ let value: ContentFilterEntry = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `action` | [models.ContentFilterAction](../models/contentfilteraction.mdx) | :heavy_check_mark: | Action taken when the pattern matches | block | +| `action` | [models.ContentFilterAction](../models/contentfilteraction) | :heavy_check_mark: | Action taken when the pattern matches | block | | `label` | *string* | :heavy_minus_sign: | Optional label used in redaction placeholders or error messages | [API_KEY] | | `pattern` | *string* | :heavy_check_mark: | A regex pattern to match against request content | \b(sk-[a-zA-Z0-9]\{48})\b | \ No newline at end of file diff --git a/docs/models/contentpartaudio.mdx b/docs/models/contentpartaudio.mdx index 5ec4b08dc..765fd8f92 100644 --- a/docs/models/contentpartaudio.mdx +++ b/docs/models/contentpartaudio.mdx @@ -19,5 +19,5 @@ let value: ContentPartAudio = { | Field | Type | Required | Description | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `audioUrl` | [models.AudioUrl](../models/audiourl.mdx) | :heavy_check_mark: | N/A | +| `audioUrl` | [models.AudioUrl](../models/audiourl) | :heavy_check_mark: | N/A | | `type` | *"audio_url"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/contentpartimage.mdx b/docs/models/contentpartimage.mdx index 711c5f2c0..aaf7362af 100644 --- a/docs/models/contentpartimage.mdx +++ b/docs/models/contentpartimage.mdx @@ -19,5 +19,5 @@ let value: ContentPartImage = { | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `imageUrl` | [models.ContentPartImageImageUrl](../models/contentpartimageimageurl.mdx) | :heavy_check_mark: | N/A | -| `type` | [models.ContentPartImageType](../models/contentpartimagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `imageUrl` | [models.ContentPartImageImageUrl](../models/contentpartimageimageurl) | :heavy_check_mark: | N/A | +| `type` | [models.ContentPartImageType](../models/contentpartimagetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/contentpartinputaudio.mdx b/docs/models/contentpartinputaudio.mdx index efd28cccd..90698a9c9 100644 --- a/docs/models/contentpartinputaudio.mdx +++ b/docs/models/contentpartinputaudio.mdx @@ -19,5 +19,5 @@ let value: ContentPartInputAudio = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `inputAudio` | [models.MultimodalMedia](../models/multimodalmedia.mdx) | :heavy_check_mark: | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | +| `inputAudio` | [models.MultimodalMedia](../models/multimodalmedia) | :heavy_check_mark: | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | | `type` | *"input_audio"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/contentpartinputfile.mdx b/docs/models/contentpartinputfile.mdx index 9e18f25b3..755c329e7 100644 --- a/docs/models/contentpartinputfile.mdx +++ b/docs/models/contentpartinputfile.mdx @@ -19,5 +19,5 @@ let value: ContentPartInputFile = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `inputFile` | [models.MultimodalMedia](../models/multimodalmedia.mdx) | :heavy_check_mark: | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | +| `inputFile` | [models.MultimodalMedia](../models/multimodalmedia) | :heavy_check_mark: | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | | `type` | *"input_file"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/contentpartinputvideo.mdx b/docs/models/contentpartinputvideo.mdx index d6310838a..e26137fbd 100644 --- a/docs/models/contentpartinputvideo.mdx +++ b/docs/models/contentpartinputvideo.mdx @@ -19,5 +19,5 @@ let value: ContentPartInputVideo = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `inputVideo` | [models.MultimodalMedia](../models/multimodalmedia.mdx) | :heavy_check_mark: | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | +| `inputVideo` | [models.MultimodalMedia](../models/multimodalmedia) | :heavy_check_mark: | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | | `type` | *"input_video"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/contentpartvideo.mdx b/docs/models/contentpartvideo.mdx index bb31d657c..9ddeb1594 100644 --- a/docs/models/contentpartvideo.mdx +++ b/docs/models/contentpartvideo.mdx @@ -20,4 +20,4 @@ let value: ContentPartVideo = { | Field | Type | Required | Description | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | | `type` | *"video_url"* | :heavy_check_mark: | N/A | -| `videoUrl` | [models.VideoUrl](../models/videourl.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `videoUrl` | [models.VideoUrl](../models/videourl) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/contentservertooluse.mdx b/docs/models/contentservertooluse.mdx index 0039c0459..2830f0f31 100644 --- a/docs/models/contentservertooluse.mdx +++ b/docs/models/contentservertooluse.mdx @@ -18,7 +18,7 @@ let value: ContentServerToolUse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/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"
} | +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | | `id` | *string* | :heavy_check_mark: | N/A | | | `input` | *any* | :heavy_minus_sign: | N/A | | | `name` | *string* | :heavy_check_mark: | N/A | | diff --git a/docs/models/contenttoolresult.mdx b/docs/models/contenttoolresult.mdx index 45eddeac2..97e5db582 100644 --- a/docs/models/contenttoolresult.mdx +++ b/docs/models/contenttoolresult.mdx @@ -17,7 +17,7 @@ let value: ContentToolResult = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/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"
} | +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective) | :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` | *models.MessagesMessageParamContentUnion2* | :heavy_minus_sign: | N/A | | | `isError` | *boolean* | :heavy_minus_sign: | N/A | | | `toolUseId` | *string* | :heavy_check_mark: | N/A | | diff --git a/docs/models/contenttooluse.mdx b/docs/models/contenttooluse.mdx index b957b4de9..4b42a4405 100644 --- a/docs/models/contenttooluse.mdx +++ b/docs/models/contenttooluse.mdx @@ -18,7 +18,7 @@ let value: ContentToolUse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/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"
} | +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | | `id` | *string* | :heavy_check_mark: | N/A | | | `input` | *any* | :heavy_minus_sign: | N/A | | | `name` | *string* | :heavy_check_mark: | N/A | | diff --git a/docs/models/contentwebsearchtoolresult.mdx b/docs/models/contentwebsearchtoolresult.mdx index 1e26ba9de..db54b9cca 100644 --- a/docs/models/contentwebsearchtoolresult.mdx +++ b/docs/models/contentwebsearchtoolresult.mdx @@ -25,7 +25,7 @@ let value: ContentWebSearchToolResult = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/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"
} | +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective) | :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` | *models.MessagesMessageParamContentUnion3* | :heavy_check_mark: | N/A | | | `toolUseId` | *string* | :heavy_check_mark: | N/A | | | `type` | *"web_search_tool_result"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/contentwebsearchtoolresulterror.mdx b/docs/models/contentwebsearchtoolresulterror.mdx index 09f35fed5..90732fb9a 100644 --- a/docs/models/contentwebsearchtoolresulterror.mdx +++ b/docs/models/contentwebsearchtoolresulterror.mdx @@ -17,5 +17,5 @@ let value: ContentWebSearchToolResultError = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `errorCode` | [models.ErrorCode](../models/errorcode.mdx) | :heavy_check_mark: | N/A | -| `type` | [models.TypeWebSearchToolResultError](../models/typewebsearchtoolresulterror.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `errorCode` | [models.ErrorCode](../models/errorcode) | :heavy_check_mark: | N/A | +| `type` | [models.TypeWebSearchToolResultError](../models/typewebsearchtoolresulterror) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/contextcompactionitem.mdx b/docs/models/contextcompactionitem.mdx index 76b698e2d..a5c22a02e 100644 --- a/docs/models/contextcompactionitem.mdx +++ b/docs/models/contextcompactionitem.mdx @@ -20,5 +20,5 @@ let value: ContextCompactionItem = { | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | | `encryptedContent` | *string* | :heavy_minus_sign: | N/A | | | `id` | *string* | :heavy_minus_sign: | N/A | | -| `type` | [models.ContextCompactionItemType](../models/contextcompactionitemtype.mdx) | :heavy_check_mark: | N/A | | +| `type` | [models.ContextCompactionItemType](../models/contextcompactionitemtype) | :heavy_check_mark: | N/A | | | `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \{
"encrypted_content": "enc_abc123...",
"type": "context_compaction"
} | \ No newline at end of file diff --git a/docs/models/contextcompressionplugin.mdx b/docs/models/contextcompressionplugin.mdx index b4c2e677e..fe3301512 100644 --- a/docs/models/contextcompressionplugin.mdx +++ b/docs/models/contextcompressionplugin.mdx @@ -17,5 +17,5 @@ let value: ContextCompressionPlugin = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | | `enabled` | *boolean* | :heavy_minus_sign: | Set to false to disable the context-compression plugin for this request. Defaults to true. | | -| `engine` | [models.ContextCompressionEngine](../models/contextcompressionengine.mdx) | :heavy_minus_sign: | The compression engine to use. Defaults to "middle-out". | middle-out | +| `engine` | [models.ContextCompressionEngine](../models/contextcompressionengine) | :heavy_minus_sign: | The compression engine to use. Defaults to "middle-out". | middle-out | | `id` | *"context-compression"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/contradiction.mdx b/docs/models/contradiction.mdx index a29683fbb..c47b8d9c0 100644 --- a/docs/models/contradiction.mdx +++ b/docs/models/contradiction.mdx @@ -22,5 +22,5 @@ let value: Contradiction = { | Field | Type | Required | Description | | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `stances` | [models.Stance](../models/stance.mdx)[] | :heavy_check_mark: | N/A | +| `stances` | [models.Stance](../models/stance)[] | :heavy_check_mark: | N/A | | `topic` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/createbyokkeyrequest.mdx b/docs/models/createbyokkeyrequest.mdx index f3d952ac1..be4f71685 100644 --- a/docs/models/createbyokkeyrequest.mdx +++ b/docs/models/createbyokkeyrequest.mdx @@ -23,5 +23,5 @@ let value: CreateBYOKKeyRequest = { | `isFallback` | *boolean* | :heavy_minus_sign: | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. | false | | `key` | *string* | :heavy_check_mark: | The raw provider API key or credential. This value is encrypted at rest and never returned in API responses. | sk-proj-abc123... | | `name` | *string* | :heavy_minus_sign: | Optional human-readable name for the credential. | Production OpenAI Key | -| `provider` | [models.BYOKProviderSlug](../models/byokproviderslug.mdx) | :heavy_check_mark: | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | +| `provider` | [models.BYOKProviderSlug](../models/byokproviderslug) | :heavy_check_mark: | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | | `workspaceId` | *string* | :heavy_minus_sign: | Optional workspace ID. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/createbyokkeyresponse.mdx b/docs/models/createbyokkeyresponse.mdx index 5a4e46add..2984c3272 100644 --- a/docs/models/createbyokkeyresponse.mdx +++ b/docs/models/createbyokkeyresponse.mdx @@ -28,4 +28,4 @@ let value: CreateBYOKKeyResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [models.BYOKKey](../models/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",
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_fallback": 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` | [models.BYOKKey](../models/byokkey) | :heavy_check_mark: | N/A | \{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_fallback": false,
"label": "sk-...AbCd",
"name": "Production OpenAI Key",
"provider": "openai",
"sort_order": 0,
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/createguardrailrequest.mdx b/docs/models/createguardrailrequest.mdx index 95263922b..20ed789b9 100644 --- a/docs/models/createguardrailrequest.mdx +++ b/docs/models/createguardrailrequest.mdx @@ -18,8 +18,8 @@ let value: CreateGuardrailRequest = { | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `allowedModels` | *string*[] | :heavy_minus_sign: | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2",
"anthropic/claude-4.5-opus-20251124",
"deepseek/deepseek-r1-0528:free"
] | | `allowedProviders` | *string*[] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | -| `contentFilterBuiltins` | [models.ContentFilterBuiltinEntryInput](../models/contentfilterbuiltinentryinput.mdx)[] | :heavy_minus_sign: | Builtin content filters to apply. Every builtin slug supports "block", "redact", and the detect-only "flag" action. | [
\{
"action": "block",
"slug": "regex-prompt-injection"
}
] | -| `contentFilters` | [models.ContentFilterEntry](../models/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"
}
] | +| `contentFilterBuiltins` | [models.ContentFilterBuiltinEntryInput](../models/contentfilterbuiltinentryinput)[] | :heavy_minus_sign: | Builtin content filters to apply. Every builtin slug supports "block", "redact", and the detect-only "flag" action. | [
\{
"action": "block",
"slug": "regex-prompt-injection"
}
] | +| `contentFilters` | [models.ContentFilterEntry](../models/contentfilterentry)[] | :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` | *string* | :heavy_minus_sign: | Description of the guardrail | A guardrail for limiting API usage | | `enableFreeModelPublication` | *boolean* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that publish prompts. | false | | `enableFreeModelTraining` | *boolean* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that train on request data. | true | @@ -35,5 +35,5 @@ let value: CreateGuardrailRequest = { | `includeByokInBudgets` | *boolean* | :heavy_minus_sign: | Whether BYOK (bring-your-own-key) inference spend counts toward this guardrail's limit_usd, in addition to OpenRouter credit spend. Defaults to false. | false | | `limitUsd` | *number* | :heavy_minus_sign: | Spending limit in USD | 50 | | `name` | *string* | :heavy_check_mark: | Name for the new guardrail | My New Guardrail | -| `resetInterval` | [models.GuardrailInterval](../models/guardrailinterval.mdx) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | +| `resetInterval` | [models.GuardrailInterval](../models/guardrailinterval) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | | `workspaceId` | *string* | :heavy_minus_sign: | The workspace to create the guardrail in. Defaults to the default workspace if not provided. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/createguardrailresponse.mdx b/docs/models/createguardrailresponse.mdx index 3aed09054..2bd7dc633 100644 --- a/docs/models/createguardrailresponse.mdx +++ b/docs/models/createguardrailresponse.mdx @@ -22,4 +22,4 @@ let value: CreateGuardrailResponse = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.Guardrail](../models/guardrail.mdx) | :heavy_check_mark: | N/A | \{
"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` | [models.Guardrail](../models/guardrail) | :heavy_check_mark: | N/A | \{
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"google"
],
"content_filter_builtins": [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
],
"content_filters": null,
"created_at": "2025-08-24T10:30:00Z",
"description": "Guardrail for production environment",
"enable_free_model_publication": false,
"enable_free_model_training": true,
"enable_paid_model_training": true,
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"include_byok_in_budgets": false,
"limit_usd": 100,
"name": "Production Guardrail",
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file diff --git a/docs/models/createobservabilitydestinationrequest.mdx b/docs/models/createobservabilitydestinationrequest.mdx index 909843822..80d0e8a2e 100644 --- a/docs/models/createobservabilitydestinationrequest.mdx +++ b/docs/models/createobservabilitydestinationrequest.mdx @@ -25,9 +25,9 @@ let value: CreateObservabilityDestinationRequest = { | `apiKeyHashes` | *string*[] | :heavy_minus_sign: | Optional allowlist of OpenRouter API key hashes whose traffic is forwarded. `null` or omitted means all keys. Must contain at least one hash if provided. | null | | `config` | Record\ | :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` | *boolean* | :heavy_minus_sign: | Whether this destination should be enabled immediately. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfigNullable](../models/observabilityfilterrulesconfignullable.mdx) | :heavy_minus_sign: | Optional structured filter rules controlling which events are forwarded. | null | +| `filterRules` | [models.ObservabilityFilterRulesConfigNullable](../models/observabilityfilterrulesconfignullable) | :heavy_minus_sign: | Optional structured filter rules controlling which events are forwarded. | null | | `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | | `privacyMode` | *boolean* | :heavy_minus_sign: | When true, request/response bodies are not forwarded — only metadata. | false | | `samplingRate` | *number* | :heavy_minus_sign: | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [models.CreateObservabilityDestinationRequestType](../models/createobservabilitydestinationrequesttype.mdx) | :heavy_check_mark: | The destination type. Only stable destination types are accepted. | langfuse | +| `type` | [models.CreateObservabilityDestinationRequestType](../models/createobservabilitydestinationrequesttype) | :heavy_check_mark: | The destination type. Only stable destination types are accepted. | langfuse | | `workspaceId` | *string* | :heavy_minus_sign: | Optional workspace ID. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/createpresetfrominferenceresponse.mdx b/docs/models/createpresetfrominferenceresponse.mdx index 5d5ab8aae..ed4e780af 100644 --- a/docs/models/createpresetfrominferenceresponse.mdx +++ b/docs/models/createpresetfrominferenceresponse.mdx @@ -43,4 +43,4 @@ let value: CreatePresetFromInferenceResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.PresetWithDesignatedVersion](../models/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` | [models.PresetWithDesignatedVersion](../models/presetwithdesignatedversion) | :heavy_check_mark: | A preset with its currently designated version. | \{
"created_at": "2026-04-20T10:00:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"description": null,
"designated_version": \{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
},
"designated_version_id": "550e8400-e29b-41d4-a716-446655440000",
"id": "650e8400-e29b-41d4-a716-446655440001",
"name": "my-preset",
"slug": "my-preset",
"status": "active",
"status_updated_at": null,
"updated_at": "2026-04-20T10:00:00Z",
"workspace_id": "750e8400-e29b-41d4-a716-446655440002"
} | \ No newline at end of file diff --git a/docs/models/createworkspaceresponse.mdx b/docs/models/createworkspaceresponse.mdx index 8a91305dd..c56c19256 100644 --- a/docs/models/createworkspaceresponse.mdx +++ b/docs/models/createworkspaceresponse.mdx @@ -33,4 +33,4 @@ let value: CreateWorkspaceResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.Workspace](../models/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",
"id": "550e8400-e29b-41d4-a716-446655440000",
"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` | [models.Workspace](../models/workspace) | :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",
"id": "550e8400-e29b-41d4-a716-446655440000",
"io_logging_api_key_ids": null,
"io_logging_sampling_rate": 1,
"is_data_discount_logging_enabled": true,
"is_observability_broadcast_enabled": false,
"is_observability_io_logging_enabled": false,
"name": "Production",
"slug": "production",
"updated_at": "2025-08-24T15:45:00Z"
} | \ No newline at end of file diff --git a/docs/models/customtool.mdx b/docs/models/customtool.mdx index c9604a8c4..29705bcab 100644 --- a/docs/models/customtool.mdx +++ b/docs/models/customtool.mdx @@ -22,4 +22,4 @@ let value: CustomTool = { | `description` | *string* | :heavy_minus_sign: | N/A | | `format` | *models.Format* | :heavy_minus_sign: | N/A | | `name` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.CustomToolTypeCustom](../models/customtooltypecustom.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.CustomToolTypeCustom](../models/customtooltypecustom) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/customtoolcallitem.mdx b/docs/models/customtoolcallitem.mdx index 8d9ba1f19..73c582417 100644 --- a/docs/models/customtoolcallitem.mdx +++ b/docs/models/customtoolcallitem.mdx @@ -26,4 +26,4 @@ let value: CustomToolCallItem = { | `input` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_check_mark: | N/A | | `namespace` | *string* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | -| `type` | [models.CustomToolCallItemType](../models/customtoolcallitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.CustomToolCallItemType](../models/customtoolcallitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/customtoolcalloutputitem.mdx b/docs/models/customtoolcalloutputitem.mdx index d9de4b91f..46d03a5ef 100644 --- a/docs/models/customtoolcalloutputitem.mdx +++ b/docs/models/customtoolcalloutputitem.mdx @@ -23,4 +23,4 @@ let value: CustomToolCallOutputItem = { | `callId` | *string* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_minus_sign: | N/A | | `output` | *models.CustomToolCallOutputItemOutputUnion2* | :heavy_check_mark: | N/A | -| `type` | [models.CustomToolCallOutputItemTypeCustomToolCallOutput](../models/customtoolcalloutputitemtypecustomtoolcalloutput.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.CustomToolCallOutputItemTypeCustomToolCallOutput](../models/customtoolcalloutputitemtypecustomtoolcalloutput) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/customtoolcalloutputitemoutputinputimage.mdx b/docs/models/customtoolcalloutputitemoutputinputimage.mdx index ed2dcbc01..223a77bec 100644 --- a/docs/models/customtoolcalloutputitemoutputinputimage.mdx +++ b/docs/models/customtoolcalloutputitemoutputinputimage.mdx @@ -19,6 +19,6 @@ let value: CustomToolCallOutputItemOutputInputImage = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `detail` | [models.CustomToolCallOutputItemDetail](../models/customtoolcalloutputitemdetail.mdx) | :heavy_check_mark: | N/A | +| `detail` | [models.CustomToolCallOutputItemDetail](../models/customtoolcalloutputitemdetail) | :heavy_check_mark: | N/A | | `imageUrl` | *string* | :heavy_minus_sign: | N/A | | `type` | *"input_image"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/datetimeservertool.mdx b/docs/models/datetimeservertool.mdx index e35bc82ca..9584b6404 100644 --- a/docs/models/datetimeservertool.mdx +++ b/docs/models/datetimeservertool.mdx @@ -18,5 +18,5 @@ let value: DatetimeServerTool = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `parameters` | [models.DatetimeServerToolConfig](../models/datetimeservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:datetime server tool | \{
"timezone": "America/New_York"
} | -| `type` | [models.DatetimeServerToolType](../models/datetimeservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.DatetimeServerToolConfig](../models/datetimeservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:datetime server tool | \{
"timezone": "America/New_York"
} | +| `type` | [models.DatetimeServerToolType](../models/datetimeservertooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/debug.mdx b/docs/models/debug.mdx index 81a9d6204..c6d83d140 100644 --- a/docs/models/debug.mdx +++ b/docs/models/debug.mdx @@ -15,4 +15,4 @@ let value: Debug = {}; | Field | Type | Required | Description | | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | | `echoUpstreamBody` | Record\ | :heavy_minus_sign: | N/A | -| `timings` | [models.Timings](../models/timings.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `timings` | [models.Timings](../models/timings) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/debugevent.mdx b/docs/models/debugevent.mdx index e97d11f40..dda629350 100644 --- a/docs/models/debugevent.mdx +++ b/docs/models/debugevent.mdx @@ -20,6 +20,6 @@ let value: DebugEvent = { | Field | Type | Required | Description | | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | -| `debug` | [models.Debug](../models/debug.mdx) | :heavy_check_mark: | N/A | +| `debug` | [models.Debug](../models/debug) | :heavy_check_mark: | N/A | | `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | `type` | *"response.debug"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/easyinputmessage.mdx b/docs/models/easyinputmessage.mdx index 43ebca4bb..3de6c3926 100644 --- a/docs/models/easyinputmessage.mdx +++ b/docs/models/easyinputmessage.mdx @@ -19,4 +19,4 @@ let value: EasyInputMessage = { | `content` | *models.EasyInputMessageContentUnion2* | :heavy_minus_sign: | N/A | | | `phase` | *models.EasyInputMessagePhaseUnion* | :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` | *models.EasyInputMessageRoleUnion* | :heavy_check_mark: | N/A | | -| `type` | [models.EasyInputMessageTypeMessage](../models/easyinputmessagetypemessage.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `type` | [models.EasyInputMessageTypeMessage](../models/easyinputmessagetypemessage) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/easyinputmessagecontentinputimage.mdx b/docs/models/easyinputmessagecontentinputimage.mdx index 521cab852..836f7b098 100644 --- a/docs/models/easyinputmessagecontentinputimage.mdx +++ b/docs/models/easyinputmessagecontentinputimage.mdx @@ -19,6 +19,6 @@ let value: EasyInputMessageContentInputImage = { | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `detail` | [models.EasyInputMessageDetail](../models/easyinputmessagedetail.mdx) | :heavy_check_mark: | N/A | +| `detail` | [models.EasyInputMessageDetail](../models/easyinputmessagedetail) | :heavy_check_mark: | N/A | | `imageUrl` | *string* | :heavy_minus_sign: | N/A | | `type` | *"input_image"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/editcleartooluses20250919.mdx b/docs/models/editcleartooluses20250919.mdx index 1981aa582..b6accd6d4 100644 --- a/docs/models/editcleartooluses20250919.mdx +++ b/docs/models/editcleartooluses20250919.mdx @@ -16,9 +16,9 @@ let value: EditClearToolUses20250919 = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `clearAtLeast` | [models.AnthropicInputTokensClearAtLeast](../models/anthropicinputtokensclearatleast.mdx) | :heavy_minus_sign: | N/A | \{
"type": "input_tokens",
"value": 50000
} | +| `clearAtLeast` | [models.AnthropicInputTokensClearAtLeast](../models/anthropicinputtokensclearatleast) | :heavy_minus_sign: | N/A | \{
"type": "input_tokens",
"value": 50000
} | | `clearToolInputs` | *models.ClearToolInputs* | :heavy_minus_sign: | N/A | | | `excludeTools` | *string*[] | :heavy_minus_sign: | N/A | | -| `keep` | [models.AnthropicToolUsesKeep](../models/anthropictooluseskeep.mdx) | :heavy_minus_sign: | N/A | \{
"type": "tool_uses",
"value": 5
} | +| `keep` | [models.AnthropicToolUsesKeep](../models/anthropictooluseskeep) | :heavy_minus_sign: | N/A | \{
"type": "tool_uses",
"value": 5
} | | `trigger` | *models.Trigger* | :heavy_minus_sign: | N/A | | | `type` | *"clear_tool_uses_20250919"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/editcompact20260112.mdx b/docs/models/editcompact20260112.mdx index fcb43b4d8..e9f364d13 100644 --- a/docs/models/editcompact20260112.mdx +++ b/docs/models/editcompact20260112.mdx @@ -18,5 +18,5 @@ let value: EditCompact20260112 = { | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | | `instructions` | *string* | :heavy_minus_sign: | N/A | | | `pauseAfterCompaction` | *boolean* | :heavy_minus_sign: | N/A | | -| `trigger` | [models.TriggerInputTokens](../models/triggerinputtokens.mdx) | :heavy_minus_sign: | N/A | \{
"type": "input_tokens",
"value": 100000
} | +| `trigger` | [models.TriggerInputTokens](../models/triggerinputtokens) | :heavy_minus_sign: | N/A | \{
"type": "input_tokens",
"value": 100000
} | | `type` | *"compact_20260112"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/endpointsmetadata.mdx b/docs/models/endpointsmetadata.mdx index e892e58d4..6ffe275b5 100644 --- a/docs/models/endpointsmetadata.mdx +++ b/docs/models/endpointsmetadata.mdx @@ -23,5 +23,5 @@ let value: EndpointsMetadata = { | Field | Type | Required | Description | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `available` | [models.EndpointInfo](../models/endpointinfo.mdx)[] | :heavy_check_mark: | N/A | +| `available` | [models.EndpointInfo](../models/endpointinfo)[] | :heavy_check_mark: | N/A | | `total` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/errors/badgatewayresponseerror.mdx b/docs/models/errors/badgatewayresponseerror.mdx index e784eea81..4c774d911 100644 --- a/docs/models/errors/badgatewayresponseerror.mdx +++ b/docs/models/errors/badgatewayresponseerror.mdx @@ -16,6 +16,6 @@ import { BadGatewayResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `error` | [models.BadGatewayResponseErrorData](../../models/badgatewayresponseerrordata.mdx) | :heavy_check_mark: | Error data for BadGatewayResponse | \{
"code": 502,
"message": "Provider returned error"
} | +| `error` | [models.BadGatewayResponseErrorData](../../models/badgatewayresponseerrordata) | :heavy_check_mark: | Error data for BadGatewayResponse | \{
"code": 502,
"message": "Provider returned error"
} | | `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | | `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/errors/badrequestresponseerror.mdx b/docs/models/errors/badrequestresponseerror.mdx index 7bf21fec7..1487b4f62 100644 --- a/docs/models/errors/badrequestresponseerror.mdx +++ b/docs/models/errors/badrequestresponseerror.mdx @@ -16,6 +16,6 @@ import { BadRequestResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `error` | [models.BadRequestResponseErrorData](../../models/badrequestresponseerrordata.mdx) | :heavy_check_mark: | Error data for BadRequestResponse | \{
"code": 400,
"message": "Invalid request parameters"
} | +| `error` | [models.BadRequestResponseErrorData](../../models/badrequestresponseerrordata) | :heavy_check_mark: | Error data for BadRequestResponse | \{
"code": 400,
"message": "Invalid request parameters"
} | | `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | | `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/errors/conflictresponseerror.mdx b/docs/models/errors/conflictresponseerror.mdx index 7bbe26524..d5e43eaa4 100644 --- a/docs/models/errors/conflictresponseerror.mdx +++ b/docs/models/errors/conflictresponseerror.mdx @@ -16,6 +16,6 @@ import { ConflictResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `error` | [models.ConflictResponseErrorData](../../models/conflictresponseerrordata.mdx) | :heavy_check_mark: | Error data for ConflictResponse | \{
"code": 409,
"message": "Resource conflict. Please try again later."
} | +| `error` | [models.ConflictResponseErrorData](../../models/conflictresponseerrordata) | :heavy_check_mark: | Error data for ConflictResponse | \{
"code": 409,
"message": "Resource conflict. Please try again later."
} | | `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | | `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/errors/edgenetworktimeoutresponseerror.mdx b/docs/models/errors/edgenetworktimeoutresponseerror.mdx index 4f43be5ac..79e23f1e6 100644 --- a/docs/models/errors/edgenetworktimeoutresponseerror.mdx +++ b/docs/models/errors/edgenetworktimeoutresponseerror.mdx @@ -16,6 +16,6 @@ import { EdgeNetworkTimeoutResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| `error` | [models.EdgeNetworkTimeoutResponseErrorData](../../models/edgenetworktimeoutresponseerrordata.mdx) | :heavy_check_mark: | Error data for EdgeNetworkTimeoutResponse | \{
"code": 524,
"message": "Request timed out. Please try again later."
} | +| `error` | [models.EdgeNetworkTimeoutResponseErrorData](../../models/edgenetworktimeoutresponseerrordata) | :heavy_check_mark: | Error data for EdgeNetworkTimeoutResponse | \{
"code": 524,
"message": "Request timed out. Please try again later."
} | | `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | | `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/errors/forbiddenresponseerror.mdx b/docs/models/errors/forbiddenresponseerror.mdx index 12da58092..2b2e90ddc 100644 --- a/docs/models/errors/forbiddenresponseerror.mdx +++ b/docs/models/errors/forbiddenresponseerror.mdx @@ -16,6 +16,6 @@ import { ForbiddenResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `error` | [models.ForbiddenResponseErrorData](../../models/forbiddenresponseerrordata.mdx) | :heavy_check_mark: | Error data for ForbiddenResponse | \{
"code": 403,
"message": "Only management keys can perform this operation"
} | +| `error` | [models.ForbiddenResponseErrorData](../../models/forbiddenresponseerrordata) | :heavy_check_mark: | Error data for ForbiddenResponse | \{
"code": 403,
"message": "Only management keys can perform this operation"
} | | `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | | `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/errors/internalserverresponseerror.mdx b/docs/models/errors/internalserverresponseerror.mdx index b3d9a23cd..95ec5b1f9 100644 --- a/docs/models/errors/internalserverresponseerror.mdx +++ b/docs/models/errors/internalserverresponseerror.mdx @@ -16,6 +16,6 @@ import { InternalServerResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `error` | [models.InternalServerResponseErrorData](../../models/internalserverresponseerrordata.mdx) | :heavy_check_mark: | Error data for InternalServerResponse | \{
"code": 500,
"message": "Internal Server Error"
} | +| `error` | [models.InternalServerResponseErrorData](../../models/internalserverresponseerrordata) | :heavy_check_mark: | Error data for InternalServerResponse | \{
"code": 500,
"message": "Internal Server Error"
} | | `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | | `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/errors/notfoundresponseerror.mdx b/docs/models/errors/notfoundresponseerror.mdx index 7bb92d48e..8bac7d27c 100644 --- a/docs/models/errors/notfoundresponseerror.mdx +++ b/docs/models/errors/notfoundresponseerror.mdx @@ -16,6 +16,6 @@ import { NotFoundResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `error` | [models.NotFoundResponseErrorData](../../models/notfoundresponseerrordata.mdx) | :heavy_check_mark: | Error data for NotFoundResponse | \{
"code": 404,
"message": "Resource not found"
} | +| `error` | [models.NotFoundResponseErrorData](../../models/notfoundresponseerrordata) | :heavy_check_mark: | Error data for NotFoundResponse | \{
"code": 404,
"message": "Resource not found"
} | | `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | | `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/errors/payloadtoolargeresponseerror.mdx b/docs/models/errors/payloadtoolargeresponseerror.mdx index 1372539eb..2d1fc598c 100644 --- a/docs/models/errors/payloadtoolargeresponseerror.mdx +++ b/docs/models/errors/payloadtoolargeresponseerror.mdx @@ -16,6 +16,6 @@ import { PayloadTooLargeResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| `error` | [models.PayloadTooLargeResponseErrorData](../../models/payloadtoolargeresponseerrordata.mdx) | :heavy_check_mark: | Error data for PayloadTooLargeResponse | \{
"code": 413,
"message": "Request payload too large"
} | +| `error` | [models.PayloadTooLargeResponseErrorData](../../models/payloadtoolargeresponseerrordata) | :heavy_check_mark: | Error data for PayloadTooLargeResponse | \{
"code": 413,
"message": "Request payload too large"
} | | `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | | `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/errors/paymentrequiredresponseerror.mdx b/docs/models/errors/paymentrequiredresponseerror.mdx index 0bb8961d4..ecff57b1a 100644 --- a/docs/models/errors/paymentrequiredresponseerror.mdx +++ b/docs/models/errors/paymentrequiredresponseerror.mdx @@ -16,6 +16,6 @@ import { PaymentRequiredResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `error` | [models.PaymentRequiredResponseErrorData](../../models/paymentrequiredresponseerrordata.mdx) | :heavy_check_mark: | Error data for PaymentRequiredResponse | \{
"code": 402,
"message": "Insufficient credits. Add more using https://openrouter.ai/credits"
} | +| `error` | [models.PaymentRequiredResponseErrorData](../../models/paymentrequiredresponseerrordata) | :heavy_check_mark: | Error data for PaymentRequiredResponse | \{
"code": 402,
"message": "Insufficient credits. Add more using https://openrouter.ai/credits"
} | | `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | | `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/errors/provideroverloadedresponseerror.mdx b/docs/models/errors/provideroverloadedresponseerror.mdx index a6a996fe3..89a119383 100644 --- a/docs/models/errors/provideroverloadedresponseerror.mdx +++ b/docs/models/errors/provideroverloadedresponseerror.mdx @@ -16,6 +16,6 @@ import { ProviderOverloadedResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| `error` | [models.ProviderOverloadedResponseErrorData](../../models/provideroverloadedresponseerrordata.mdx) | :heavy_check_mark: | Error data for ProviderOverloadedResponse | \{
"code": 529,
"message": "Provider returned error"
} | +| `error` | [models.ProviderOverloadedResponseErrorData](../../models/provideroverloadedresponseerrordata) | :heavy_check_mark: | Error data for ProviderOverloadedResponse | \{
"code": 529,
"message": "Provider returned error"
} | | `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | | `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/errors/requesttimeoutresponseerror.mdx b/docs/models/errors/requesttimeoutresponseerror.mdx index 4e36c370a..02cecddca 100644 --- a/docs/models/errors/requesttimeoutresponseerror.mdx +++ b/docs/models/errors/requesttimeoutresponseerror.mdx @@ -16,6 +16,6 @@ import { RequestTimeoutResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `error` | [models.RequestTimeoutResponseErrorData](../../models/requesttimeoutresponseerrordata.mdx) | :heavy_check_mark: | Error data for RequestTimeoutResponse | \{
"code": 408,
"message": "Operation timed out. Please try again later."
} | +| `error` | [models.RequestTimeoutResponseErrorData](../../models/requesttimeoutresponseerrordata) | :heavy_check_mark: | Error data for RequestTimeoutResponse | \{
"code": 408,
"message": "Operation timed out. Please try again later."
} | | `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | | `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/errors/serviceunavailableresponseerror.mdx b/docs/models/errors/serviceunavailableresponseerror.mdx index 79961f7c1..b3fc15cb9 100644 --- a/docs/models/errors/serviceunavailableresponseerror.mdx +++ b/docs/models/errors/serviceunavailableresponseerror.mdx @@ -16,6 +16,6 @@ import { ServiceUnavailableResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| `error` | [models.ServiceUnavailableResponseErrorData](../../models/serviceunavailableresponseerrordata.mdx) | :heavy_check_mark: | Error data for ServiceUnavailableResponse | \{
"code": 503,
"message": "Service temporarily unavailable"
} | +| `error` | [models.ServiceUnavailableResponseErrorData](../../models/serviceunavailableresponseerrordata) | :heavy_check_mark: | Error data for ServiceUnavailableResponse | \{
"code": 503,
"message": "Service temporarily unavailable"
} | | `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | | `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/errors/toomanyrequestsresponseerror.mdx b/docs/models/errors/toomanyrequestsresponseerror.mdx index a25646e87..5b33221d0 100644 --- a/docs/models/errors/toomanyrequestsresponseerror.mdx +++ b/docs/models/errors/toomanyrequestsresponseerror.mdx @@ -16,6 +16,6 @@ import { TooManyRequestsResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| `error` | [models.TooManyRequestsResponseErrorData](../../models/toomanyrequestsresponseerrordata.mdx) | :heavy_check_mark: | Error data for TooManyRequestsResponse | \{
"code": 429,
"message": "Rate limit exceeded"
} | +| `error` | [models.TooManyRequestsResponseErrorData](../../models/toomanyrequestsresponseerrordata) | :heavy_check_mark: | Error data for TooManyRequestsResponse | \{
"code": 429,
"message": "Rate limit exceeded"
} | | `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | | `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/errors/unauthorizedresponseerror.mdx b/docs/models/errors/unauthorizedresponseerror.mdx index 6d4c4de60..ffc639cb0 100644 --- a/docs/models/errors/unauthorizedresponseerror.mdx +++ b/docs/models/errors/unauthorizedresponseerror.mdx @@ -16,6 +16,6 @@ import { UnauthorizedResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `error` | [models.UnauthorizedResponseErrorData](../../models/unauthorizedresponseerrordata.mdx) | :heavy_check_mark: | Error data for UnauthorizedResponse | \{
"code": 401,
"message": "Missing Authentication header"
} | +| `error` | [models.UnauthorizedResponseErrorData](../../models/unauthorizedresponseerrordata) | :heavy_check_mark: | Error data for UnauthorizedResponse | \{
"code": 401,
"message": "Missing Authentication header"
} | | `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | | `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/errors/unprocessableentityresponseerror.mdx b/docs/models/errors/unprocessableentityresponseerror.mdx index f7d1764b9..a0a161c2d 100644 --- a/docs/models/errors/unprocessableentityresponseerror.mdx +++ b/docs/models/errors/unprocessableentityresponseerror.mdx @@ -16,6 +16,6 @@ import { UnprocessableEntityResponseError } from "@openrouter/sdk/models/errors" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `error` | [models.UnprocessableEntityResponseErrorData](../../models/unprocessableentityresponseerrordata.mdx) | :heavy_check_mark: | Error data for UnprocessableEntityResponse | \{
"code": 422,
"message": "Invalid argument"
} | +| `error` | [models.UnprocessableEntityResponseErrorData](../../models/unprocessableentityresponseerrordata) | :heavy_check_mark: | Error data for UnprocessableEntityResponse | \{
"code": 422,
"message": "Invalid argument"
} | | `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | | `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/fileparserplugin.mdx b/docs/models/fileparserplugin.mdx index 50efc278a..72df983dd 100644 --- a/docs/models/fileparserplugin.mdx +++ b/docs/models/fileparserplugin.mdx @@ -18,4 +18,4 @@ let value: FileParserPlugin = { | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | | `enabled` | *boolean* | :heavy_minus_sign: | Set to false to disable the file-parser plugin for this request. Defaults to true. | | | `id` | *"file-parser"* | :heavy_check_mark: | N/A | | -| `pdf` | [models.PDFParserOptions](../models/pdfparseroptions.mdx) | :heavy_minus_sign: | Options for PDF parsing. | \{
"engine": "cloudflare-ai"
} | \ No newline at end of file +| `pdf` | [models.PDFParserOptions](../models/pdfparseroptions) | :heavy_minus_sign: | Options for PDF parsing. | \{
"engine": "cloudflare-ai"
} | \ No newline at end of file diff --git a/docs/models/filesearchservertool.mdx b/docs/models/filesearchservertool.mdx index 8406aaa62..62f864f83 100644 --- a/docs/models/filesearchservertool.mdx +++ b/docs/models/filesearchservertool.mdx @@ -23,6 +23,6 @@ let value: FileSearchServerTool = { | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | | `filters` | *models.FiltersUnion* | :heavy_minus_sign: | N/A | | `maxNumResults` | *number* | :heavy_minus_sign: | N/A | -| `rankingOptions` | [models.RankingOptions](../models/rankingoptions.mdx) | :heavy_minus_sign: | N/A | -| `type` | [models.TypeFileSearch](../models/typefilesearch.mdx) | :heavy_check_mark: | N/A | +| `rankingOptions` | [models.RankingOptions](../models/rankingoptions) | :heavy_minus_sign: | N/A | +| `type` | [models.TypeFileSearch](../models/typefilesearch) | :heavy_check_mark: | N/A | | `vectorStoreIds` | *string*[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/filesservertool.mdx b/docs/models/filesservertool.mdx index d2247df40..7d3e0ca8d 100644 --- a/docs/models/filesservertool.mdx +++ b/docs/models/filesservertool.mdx @@ -18,5 +18,5 @@ let value: FilesServerTool = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `parameters` | [models.FilesServerToolConfig](../models/filesservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:files server tool | \{} | -| `type` | [models.FilesServerToolType](../models/filesservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.FilesServerToolConfig](../models/filesservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:files server tool | \{} | +| `type` | [models.FilesServerToolType](../models/filesservertooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/filters.mdx b/docs/models/filters.mdx index ded802ad8..0f4eef4af 100644 --- a/docs/models/filters.mdx +++ b/docs/models/filters.mdx @@ -19,5 +19,5 @@ let value: Filters = { | Field | Type | Required | Description | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | | `key` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.FiltersType](../models/filterstype.mdx) | :heavy_check_mark: | N/A | +| `type` | [models.FiltersType](../models/filterstype) | :heavy_check_mark: | N/A | | `value` | *models.FileSearchServerToolValue2* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/formatgrammar.mdx b/docs/models/formatgrammar.mdx index 08592971b..c2b8a444a 100644 --- a/docs/models/formatgrammar.mdx +++ b/docs/models/formatgrammar.mdx @@ -19,5 +19,5 @@ let value: FormatGrammar = { | Field | Type | Required | Description | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | | `definition` | *string* | :heavy_check_mark: | N/A | -| `syntax` | [models.Syntax](../models/syntax.mdx) | :heavy_check_mark: | N/A | +| `syntax` | [models.Syntax](../models/syntax) | :heavy_check_mark: | N/A | | `type` | *"grammar"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/frameimage.mdx b/docs/models/frameimage.mdx index 8a85c56fc..b2ebc77e0 100644 --- a/docs/models/frameimage.mdx +++ b/docs/models/frameimage.mdx @@ -20,6 +20,6 @@ let value: FrameImage = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `imageUrl` | [models.FrameImageImageUrl](../models/frameimageimageurl.mdx) | :heavy_check_mark: | N/A | | -| `type` | [models.FrameImageType](../models/frameimagetype.mdx) | :heavy_check_mark: | N/A | | -| `frameType` | [models.FrameType](../models/frametype.mdx) | :heavy_check_mark: | Whether this image represents the first or last frame of the video | first_frame | \ No newline at end of file +| `imageUrl` | [models.FrameImageImageUrl](../models/frameimageimageurl) | :heavy_check_mark: | N/A | | +| `type` | [models.FrameImageType](../models/frameimagetype) | :heavy_check_mark: | N/A | | +| `frameType` | [models.FrameType](../models/frametype) | :heavy_check_mark: | Whether this image represents the first or last frame of the video | first_frame | \ No newline at end of file diff --git a/docs/models/functioncallitem.mdx b/docs/models/functioncallitem.mdx index 7058cc4cb..81f35a3e5 100644 --- a/docs/models/functioncallitem.mdx +++ b/docs/models/functioncallitem.mdx @@ -27,5 +27,5 @@ let value: FunctionCallItem = { | `id` | *string* | :heavy_check_mark: | N/A | | | `name` | *string* | :heavy_check_mark: | N/A | | | `namespace` | *string* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | -| `type` | [models.FunctionCallItemType](../models/functioncallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `status` | [models.ToolCallStatus](../models/toolcallstatus) | :heavy_minus_sign: | N/A | completed | +| `type` | [models.FunctionCallItemType](../models/functioncallitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/functioncalloutputitem.mdx b/docs/models/functioncalloutputitem.mdx index 9e2466e4a..7da03e526 100644 --- a/docs/models/functioncalloutputitem.mdx +++ b/docs/models/functioncalloutputitem.mdx @@ -23,5 +23,5 @@ let value: FunctionCallOutputItem = { | `callId` | *string* | :heavy_check_mark: | N/A | | | `id` | *string* | :heavy_minus_sign: | N/A | | | `output` | *models.FunctionCallOutputItemOutputUnion2* | :heavy_check_mark: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | -| `type` | [models.FunctionCallOutputItemTypeFunctionCallOutput](../models/functioncalloutputitemtypefunctioncalloutput.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `status` | [models.ToolCallStatus](../models/toolcallstatus) | :heavy_minus_sign: | N/A | completed | +| `type` | [models.FunctionCallOutputItemTypeFunctionCallOutput](../models/functioncalloutputitemtypefunctioncalloutput) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/functioncalloutputitemoutputinputimage.mdx b/docs/models/functioncalloutputitemoutputinputimage.mdx index 10db33ad6..d3d5c4398 100644 --- a/docs/models/functioncalloutputitemoutputinputimage.mdx +++ b/docs/models/functioncalloutputitemoutputinputimage.mdx @@ -19,6 +19,6 @@ let value: FunctionCallOutputItemOutputInputImage = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `detail` | [models.FunctionCallOutputItemDetail](../models/functioncalloutputitemdetail.mdx) | :heavy_check_mark: | N/A | +| `detail` | [models.FunctionCallOutputItemDetail](../models/functioncalloutputitemdetail) | :heavy_check_mark: | N/A | | `imageUrl` | *string* | :heavy_minus_sign: | N/A | | `type` | *"input_image"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fusionanalysisresult.mdx b/docs/models/fusionanalysisresult.mdx index 04acea1be..174ea179f 100644 --- a/docs/models/fusionanalysisresult.mdx +++ b/docs/models/fusionanalysisresult.mdx @@ -55,6 +55,6 @@ let value: FusionAnalysisResult = { | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | | `blindSpots` | *string*[] | :heavy_check_mark: | N/A | | `consensus` | *string*[] | :heavy_check_mark: | N/A | -| `contradictions` | [models.Contradiction](../models/contradiction.mdx)[] | :heavy_check_mark: | N/A | -| `partialCoverage` | [models.PartialCoverage](../models/partialcoverage.mdx)[] | :heavy_check_mark: | N/A | -| `uniqueInsights` | [models.UniqueInsight](../models/uniqueinsight.mdx)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `contradictions` | [models.Contradiction](../models/contradiction)[] | :heavy_check_mark: | N/A | +| `partialCoverage` | [models.PartialCoverage](../models/partialcoverage)[] | :heavy_check_mark: | N/A | +| `uniqueInsights` | [models.UniqueInsight](../models/uniqueinsight)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/fusioncallanalysiscompletedevent.mdx b/docs/models/fusioncallanalysiscompletedevent.mdx index c70ea1e85..4434c8b9e 100644 --- a/docs/models/fusioncallanalysiscompletedevent.mdx +++ b/docs/models/fusioncallanalysiscompletedevent.mdx @@ -59,7 +59,7 @@ let value: FusionCallAnalysisCompletedEvent = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `analysis` | [models.FusionAnalysisResult](../models/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"
}
]
} | +| `analysis` | [models.FusionAnalysisResult](../models/fusionanalysisresult) | :heavy_check_mark: | Structured analysis produced by the fusion analyst model. | \{
"blind_spots": [
"No model considered the impact on existing API consumers."
],
"consensus": [
"All panel models agree the request is asking for a concise summary."
],
"contradictions": [
\{
"stances": [
\{
"model": "openai/gpt-5",
"stance": "Favors an incremental rollout."
},
\{
"model": "anthropic/claude-sonnet-4.5",
"stance": "Favors a single coordinated migration."
}
],
"topic": "Recommended approach"
}
],
"partial_coverage": [
\{
"models": [
"openai/gpt-5"
],
"point": "Only one model addressed the rollback strategy."
}
],
"unique_insights": [
\{
"insight": "Highlighted a backwards-compatibility risk the other models missed.",
"model": "anthropic/claude-sonnet-4.5"
}
]
} | | `itemId` | *string* | :heavy_check_mark: | N/A | | | `outputIndex` | *number* | :heavy_check_mark: | N/A | | | `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | diff --git a/docs/models/fusionplugin.mdx b/docs/models/fusionplugin.mdx index 5c4d23764..ccb61f312 100644 --- a/docs/models/fusionplugin.mdx +++ b/docs/models/fusionplugin.mdx @@ -21,5 +21,5 @@ let value: FusionPlugin = { | `id` | *"fusion"* | :heavy_check_mark: | N/A | | | `maxToolCalls` | *number* | :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 8. Capped at 16. | 12 | | `model` | *string* | :heavy_minus_sign: | 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` | [models.PresetEnum](../models/presetenum.mdx) | :heavy_minus_sign: | A curated OpenRouter fusion 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` | [models.FusionPluginTool](../models/fusionplugintool.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 +| `preset` | [models.PresetEnum](../models/presetenum) | :heavy_minus_sign: | A curated OpenRouter fusion 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` | [models.FusionPluginTool](../models/fusionplugintool)[] | :heavy_minus_sign: | Server tools available to panelist and analyst inner calls. Each entry uses the same `{ type, parameters? }` shorthand as the outer Chat Completions request. When omitted, defaults to `[{ type: "openrouter:web_search" }, { type: "openrouter:web_fetch" }]`. Pass an empty array to disable tools entirely (panelists answer from parametric knowledge only). | [
\{
"parameters": \{
"excluded_domains": [
"example.com"
]
},
"type": "openrouter:web_search"
},
\{
"type": "openrouter:web_fetch"
}
] | \ No newline at end of file diff --git a/docs/models/fusionservertoolconfig.mdx b/docs/models/fusionservertoolconfig.mdx index 9f991ee6b..495ecc630 100644 --- a/docs/models/fusionservertoolconfig.mdx +++ b/docs/models/fusionservertoolconfig.mdx @@ -17,10 +17,10 @@ let value: FusionServerToolConfig = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `analysisModels` | *string*[] | :heavy_minus_sign: | Slugs of models to run in parallel as the analysis panel. Each model receives the user prompt with openrouter:web_search and openrouter:web_fetch enabled, then an analyst model summarizes the collective output into structured analysis JSON. Capped at 8 models to bound cost amplification. Defaults to the Quality preset from /labs/fusion. | [
"~anthropic/claude-opus-latest",
"~openai/gpt-latest",
"~google/gemini-pro-latest"
] | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/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"
} | +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | | `maxCompletionTokens` | *number* | :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. When omitted, panelists default to 32000 and the analyst to 20000. | 16384 | | `maxToolCalls` | *number* | :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 8. Capped at 16. | 12 | | `model` | *string* | :heavy_minus_sign: | Slug of the analyst model that produces the structured analysis JSON. Defaults to the model used in the outer API request. | ~anthropic/claude-opus-latest | -| `reasoning` | [models.FusionServerToolConfigReasoning](../models/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. | | +| `reasoning` | [models.FusionServerToolConfigReasoning](../models/fusionservertoolconfigreasoning) | :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` | *number* | :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` | [models.FusionServerToolConfigTool](../models/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 +| `tools` | [models.FusionServerToolConfigTool](../models/fusionservertoolconfigtool)[] | :heavy_minus_sign: | Server tools available to panelist and analyst inner calls. Each entry uses the same `{ type, parameters? }` shorthand as the outer Chat Completions request. When omitted, defaults to `[{ type: "openrouter:web_search" }, { type: "openrouter:web_fetch" }]`. Pass an empty array to disable tools entirely (panelists answer from parametric knowledge only). | [
\{
"parameters": \{
"excluded_domains": [
"example.com"
]
},
"type": "openrouter:web_search"
},
\{
"type": "openrouter:web_fetch"
}
] | \ No newline at end of file diff --git a/docs/models/fusionservertoolconfigreasoning.mdx b/docs/models/fusionservertoolconfigreasoning.mdx index d54a33f05..1c07ea56a 100644 --- a/docs/models/fusionservertoolconfigreasoning.mdx +++ b/docs/models/fusionservertoolconfigreasoning.mdx @@ -16,5 +16,5 @@ let value: FusionServerToolConfigReasoning = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `effort` | [models.FusionServerToolConfigEffort](../models/fusionservertoolconfigeffort.mdx) | :heavy_minus_sign: | Reasoning effort level for panelist and analyst inner calls. | +| `effort` | [models.FusionServerToolConfigEffort](../models/fusionservertoolconfigeffort) | :heavy_minus_sign: | Reasoning effort level for panelist and analyst inner calls. | | `maxTokens` | *number* | :heavy_minus_sign: | Maximum number of reasoning tokens each panelist and analyst model may use. Helps bound cost when models allocate too much budget to chain-of-thought. | \ No newline at end of file diff --git a/docs/models/fusionservertoolopenrouter.mdx b/docs/models/fusionservertoolopenrouter.mdx index 8abc492c9..6bfc477ab 100644 --- a/docs/models/fusionservertoolopenrouter.mdx +++ b/docs/models/fusionservertoolopenrouter.mdx @@ -18,5 +18,5 @@ let value: FusionServerToolOpenRouter = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `parameters` | [models.FusionServerToolConfig](../models/fusionservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:fusion server tool. | \{
"analysis_models": [
"~anthropic/claude-opus-latest",
"~openai/gpt-latest",
"~google/gemini-pro-latest"
]
} | -| `type` | [models.FusionServerToolOpenRouterType](../models/fusionservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.FusionServerToolConfig](../models/fusionservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:fusion server tool. | \{
"analysis_models": [
"~anthropic/claude-opus-latest",
"~openai/gpt-latest",
"~google/gemini-pro-latest"
]
} | +| `type` | [models.FusionServerToolOpenRouterType](../models/fusionservertoolopenroutertype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/generationcontentdata.mdx b/docs/models/generationcontentdata.mdx index ca6defbf6..2ab17ba03 100644 --- a/docs/models/generationcontentdata.mdx +++ b/docs/models/generationcontentdata.mdx @@ -30,4 +30,4 @@ let value: GenerationContentData = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | | `input` | *models.InputUnion* | :heavy_check_mark: | The input to the generation — either a prompt string or an array of messages | -| `output` | [models.GenerationContentDataOutput](../models/generationcontentdataoutput.mdx) | :heavy_check_mark: | The output from the generation | \ No newline at end of file +| `output` | [models.GenerationContentDataOutput](../models/generationcontentdataoutput) | :heavy_check_mark: | The output from the generation | \ No newline at end of file diff --git a/docs/models/generationcontentresponse.mdx b/docs/models/generationcontentresponse.mdx index c21bf857c..f4f414ece 100644 --- a/docs/models/generationcontentresponse.mdx +++ b/docs/models/generationcontentresponse.mdx @@ -31,4 +31,4 @@ let value: GenerationContentResponse = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.GenerationContentData](../models/generationcontentdata.mdx) | :heavy_check_mark: | Stored prompt and completion content | \{
"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` | [models.GenerationContentData](../models/generationcontentdata) | :heavy_check_mark: | Stored prompt and completion content | \{
"input": \{
"messages": [
\{
"content": "What is the meaning of life?",
"role": "user"
}
]
},
"output": \{
"completion": "The meaning of life is a philosophical question...",
"reasoning": null
}
} | \ No newline at end of file diff --git a/docs/models/generationresponse.mdx b/docs/models/generationresponse.mdx index e0bf55d61..133c64a59 100644 --- a/docs/models/generationresponse.mdx +++ b/docs/models/generationresponse.mdx @@ -60,4 +60,4 @@ let value: GenerationResponse = { | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `data` | [models.GenerationResponseData](../models/generationresponsedata.mdx) | :heavy_check_mark: | Generation data | \ No newline at end of file +| `data` | [models.GenerationResponseData](../models/generationresponsedata) | :heavy_check_mark: | Generation data | \ No newline at end of file diff --git a/docs/models/generationresponsedata.mdx b/docs/models/generationresponsedata.mdx index d5296479a..46f1d94ed 100644 --- a/docs/models/generationresponsedata.mdx +++ b/docs/models/generationresponsedata.mdx @@ -62,12 +62,12 @@ let value: GenerationResponseData = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `apiType` | [models.ApiType](../models/apitype.mdx) | :heavy_check_mark: | Type of API used for the generation | | +| `apiType` | [models.ApiType](../models/apitype) | :heavy_check_mark: | Type of API used for the generation | | | `appId` | *number* | :heavy_check_mark: | ID of the app that made the request | 12345 | | `cacheDiscount` | *number* | :heavy_check_mark: | Discount applied due to caching | 0.0002 | | `cancelled` | *boolean* | :heavy_check_mark: | Whether the generation was cancelled | false | | `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the generation was created | 2024-07-15T23:33:19.433273+00:00 | -| `dataRegion` | [models.DataRegion](../models/dataregion.mdx) | :heavy_check_mark: | The data region this generation was routed through: 'global', 'europe', or 'us'. | global | +| `dataRegion` | [models.DataRegion](../models/dataregion) | :heavy_check_mark: | The data region this generation was routed through: 'global', 'europe', or 'us'. | global | | `externalUser` | *string* | :heavy_check_mark: | External user identifier | user-123 | | `finishReason` | *string* | :heavy_check_mark: | Reason the generation finished | stop | | `generationTime` | *number* | :heavy_check_mark: | Time taken for generation in milliseconds | 1200 | @@ -91,7 +91,7 @@ let value: GenerationResponseData = { | `origin` | *string* | :heavy_check_mark: | Origin URL of the request | https://openrouter.ai/ | | `presetId` | *string* | :heavy_check_mark: | ID of the preset used for this generation, null if no preset was used | a9e8d400-592a-494f-908c-375efa66cafd | | `providerName` | *string* | :heavy_check_mark: | Name of the provider that served the request | Infermatic | -| `providerResponses` | [models.ProviderResponse](../models/providerresponse.mdx)[] | :heavy_check_mark: | List of provider responses for this generation, including fallback attempts | | +| `providerResponses` | [models.ProviderResponse](../models/providerresponse)[] | :heavy_check_mark: | List of provider responses for this generation, including fallback attempts | | | `requestId` | *string* | :heavy_minus_sign: | Unique identifier grouping all generations from a single API request | req-1727282430-aBcDeFgHiJkLmNoPqRsT | | `responseCacheSourceId` | *string* | :heavy_minus_sign: | If this generation was served from response cache, contains the original generation ID. Null otherwise. | | | `router` | *string* | :heavy_check_mark: | Router used for the request (e.g., openrouter/auto) | openrouter/auto | diff --git a/docs/models/getbyokkeyresponse.mdx b/docs/models/getbyokkeyresponse.mdx index d09d53d10..7c038e1e5 100644 --- a/docs/models/getbyokkeyresponse.mdx +++ b/docs/models/getbyokkeyresponse.mdx @@ -28,4 +28,4 @@ let value: GetBYOKKeyResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [models.BYOKKey](../models/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",
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_fallback": 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` | [models.BYOKKey](../models/byokkey) | :heavy_check_mark: | N/A | \{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_fallback": false,
"label": "sk-...AbCd",
"name": "Production OpenAI Key",
"provider": "openai",
"sort_order": 0,
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/getguardrailresponse.mdx b/docs/models/getguardrailresponse.mdx index 6311e2bcb..35e7d0644 100644 --- a/docs/models/getguardrailresponse.mdx +++ b/docs/models/getguardrailresponse.mdx @@ -22,4 +22,4 @@ let value: GetGuardrailResponse = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.Guardrail](../models/guardrail.mdx) | :heavy_check_mark: | N/A | \{
"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` | [models.Guardrail](../models/guardrail) | :heavy_check_mark: | N/A | \{
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"google"
],
"content_filter_builtins": [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
],
"content_filters": null,
"created_at": "2025-08-24T10:30:00Z",
"description": "Guardrail for production environment",
"enable_free_model_publication": false,
"enable_free_model_training": true,
"enable_paid_model_training": true,
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"include_byok_in_budgets": false,
"limit_usd": 100,
"name": "Production Guardrail",
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file diff --git a/docs/models/getpresetresponse.mdx b/docs/models/getpresetresponse.mdx index 359221c87..e93e4e566 100644 --- a/docs/models/getpresetresponse.mdx +++ b/docs/models/getpresetresponse.mdx @@ -43,4 +43,4 @@ let value: GetPresetResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.PresetWithDesignatedVersion](../models/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` | [models.PresetWithDesignatedVersion](../models/presetwithdesignatedversion) | :heavy_check_mark: | A preset with its currently designated version. | \{
"created_at": "2026-04-20T10:00:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"description": null,
"designated_version": \{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
},
"designated_version_id": "550e8400-e29b-41d4-a716-446655440000",
"id": "650e8400-e29b-41d4-a716-446655440001",
"name": "my-preset",
"slug": "my-preset",
"status": "active",
"status_updated_at": null,
"updated_at": "2026-04-20T10:00:00Z",
"workspace_id": "750e8400-e29b-41d4-a716-446655440002"
} | \ No newline at end of file diff --git a/docs/models/getpresetversionresponse.mdx b/docs/models/getpresetversionresponse.mdx index 19a130f54..de1abeb52 100644 --- a/docs/models/getpresetversionresponse.mdx +++ b/docs/models/getpresetversionresponse.mdx @@ -30,4 +30,4 @@ let value: GetPresetVersionResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.PresetDesignatedVersion](../models/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` | [models.PresetDesignatedVersion](../models/presetdesignatedversion) | :heavy_check_mark: | A specific version of a preset, containing config and optional system prompt. | \{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
} | \ No newline at end of file diff --git a/docs/models/getworkspaceresponse.mdx b/docs/models/getworkspaceresponse.mdx index c53f552e5..74334b517 100644 --- a/docs/models/getworkspaceresponse.mdx +++ b/docs/models/getworkspaceresponse.mdx @@ -33,4 +33,4 @@ let value: GetWorkspaceResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.Workspace](../models/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",
"id": "550e8400-e29b-41d4-a716-446655440000",
"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` | [models.Workspace](../models/workspace) | :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",
"id": "550e8400-e29b-41d4-a716-446655440000",
"io_logging_api_key_ids": null,
"io_logging_sampling_rate": 1,
"is_data_discount_logging_enabled": true,
"is_observability_broadcast_enabled": false,
"is_observability_io_logging_enabled": false,
"name": "Production",
"slug": "production",
"updated_at": "2025-08-24T15:45:00Z"
} | \ No newline at end of file diff --git a/docs/models/guardrail.mdx b/docs/models/guardrail.mdx index cd119b4c4..4d4f11724 100644 --- a/docs/models/guardrail.mdx +++ b/docs/models/guardrail.mdx @@ -22,8 +22,8 @@ let value: Guardrail = { | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `allowedModels` | *string*[] | :heavy_minus_sign: | Array of model canonical_slugs (immutable identifiers) | [
"openai/gpt-5.2-20251211",
"anthropic/claude-4.5-opus-20251124",
"deepseek/deepseek-r1-0528:free"
] | | `allowedProviders` | *string*[] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"google"
] | -| `contentFilterBuiltins` | [models.ContentFilterBuiltinEntry](../models/contentfilterbuiltinentry.mdx)[] | :heavy_minus_sign: | Builtin content filters applied to requests. Includes PII detectors and the regex-based prompt injection detector. | [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
] | -| `contentFilters` | [models.ContentFilterEntry](../models/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"
}
] | +| `contentFilterBuiltins` | [models.ContentFilterBuiltinEntry](../models/contentfilterbuiltinentry)[] | :heavy_minus_sign: | Builtin content filters applied to requests. Includes PII detectors and the regex-based prompt injection detector. | [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
] | +| `contentFilters` | [models.ContentFilterEntry](../models/contentfilterentry)[] | :heavy_minus_sign: | Custom regex content filters applied to request messages | [
\{
"action": "redact",
"label": "[API_KEY]",
"pattern": "\\b(sk-[a-zA-Z0-9]\{48})\\b"
}
] | | `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the guardrail was created | 2025-08-24T10:30:00Z | | `description` | *string* | :heavy_minus_sign: | Description of the guardrail | Guardrail for production environment | | `enableFreeModelPublication` | *boolean* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that publish prompts. | false | @@ -41,6 +41,6 @@ let value: Guardrail = { | `includeByokInBudgets` | *boolean* | :heavy_check_mark: | Whether BYOK (bring-your-own-key) inference spend counts toward this guardrail's limit_usd, in addition to OpenRouter credit spend. | false | | `limitUsd` | *number* | :heavy_minus_sign: | Spending limit in USD | 100 | | `name` | *string* | :heavy_check_mark: | Name of the guardrail | Production Guardrail | -| `resetInterval` | [models.GuardrailInterval](../models/guardrailinterval.mdx) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | +| `resetInterval` | [models.GuardrailInterval](../models/guardrailinterval) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | | `updatedAt` | *string* | :heavy_minus_sign: | ISO 8601 timestamp of when the guardrail was last updated | 2025-08-24T15:45:00Z | | `workspaceId` | *string* | :heavy_check_mark: | The workspace ID this guardrail belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/imageendpoint.mdx b/docs/models/imageendpoint.mdx index 43dc17049..4e3145942 100644 --- a/docs/models/imageendpoint.mdx +++ b/docs/models/imageendpoint.mdx @@ -43,7 +43,7 @@ let value: ImageEndpoint = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `allowedPassthroughParameters` | *string*[] | :heavy_check_mark: | Provider-specific options accepted under provider.options[provider_slug]. | [] | -| `pricing` | [models.ImagePricingEntry](../models/imagepricingentry.mdx)[] | :heavy_check_mark: | Billable pricing lines for this endpoint. | [
\{
"billable": "output_image",
"cost_usd": 0.05,
"unit": "image"
}
] | +| `pricing` | [models.ImagePricingEntry](../models/imagepricingentry)[] | :heavy_check_mark: | Billable pricing lines for this endpoint. | [
\{
"billable": "output_image",
"cost_usd": 0.05,
"unit": "image"
}
] | | `providerName` | *string* | :heavy_check_mark: | Provider display name | Bytedance | | `providerSlug` | *string* | :heavy_check_mark: | Provider slug | bytedance | | `providerTag` | *string* | :heavy_check_mark: | Provider tag for request-side selection | bytedance | diff --git a/docs/models/imagegencompletedevent.mdx b/docs/models/imagegencompletedevent.mdx index 912a30499..250e4bbe4 100644 --- a/docs/models/imagegencompletedevent.mdx +++ b/docs/models/imagegencompletedevent.mdx @@ -24,4 +24,4 @@ let value: ImageGenCompletedEvent = { | `created` | *number* | :heavy_check_mark: | Unix timestamp (seconds) when the image was generated | | | `mediaType` | *string* | :heavy_minus_sign: | Media type (MIME type) of the image, e.g. `image/png`, `image/jpeg`, `image/webp`, `image/svg+xml`. May be omitted if the format could not be determined. | image/png | | `type` | *"image_generation.completed"* | :heavy_check_mark: | The event type | | -| `usage` | [models.ImageGenerationUsage](../models/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 +| `usage` | [models.ImageGenerationUsage](../models/imagegenerationusage) | :heavy_minus_sign: | Token and cost usage for the image generation request, when available | \{
"completion_tokens": 4175,
"cost": 0.04,
"prompt_tokens": 0,
"total_tokens": 4175
} | \ No newline at end of file diff --git a/docs/models/imagegenerationproviderpreferences.mdx b/docs/models/imagegenerationproviderpreferences.mdx index 0837c07c6..b0a3dd2bb 100644 --- a/docs/models/imagegenerationproviderpreferences.mdx +++ b/docs/models/imagegenerationproviderpreferences.mdx @@ -19,6 +19,6 @@ let value: ImageGenerationProviderPreferences = {}; | `allowFallbacks` | *boolean* | :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` | *models.ImageGenerationProviderPreferencesIgnore*[] | :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` | *models.ImageGenerationProviderPreferencesOnly*[] | :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` | [models.ImageGenerationProviderPreferencesOptions](../models/imagegenerationproviderpreferencesoptions.mdx) | :heavy_minus_sign: | N/A | \{
"black-forest-labs": \{
"guidance": 3,
"steps": 40
}
} | +| `options` | [models.ImageGenerationProviderPreferencesOptions](../models/imagegenerationproviderpreferencesoptions) | :heavy_minus_sign: | N/A | \{
"black-forest-labs": \{
"guidance": 3,
"steps": 40
}
} | | `order` | *models.ImageGenerationProviderPreferencesOrder*[] | :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` | *models.ImageGenerationProviderPreferencesSort* | :heavy_minus_sign: | The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. | price | \ No newline at end of file diff --git a/docs/models/imagegenerationrequest.mdx b/docs/models/imagegenerationrequest.mdx index de07f7429..b1a24d5cc 100644 --- a/docs/models/imagegenerationrequest.mdx +++ b/docs/models/imagegenerationrequest.mdx @@ -19,17 +19,17 @@ let value: ImageGenerationRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `aspectRatio` | [models.ImageGenerationRequestAspectRatio](../models/imagegenerationrequestaspectratio.mdx) | :heavy_minus_sign: | Normalized aspect ratio of the generated image. Providers clamp to their supported subset. | 16:9 | -| `background` | [models.ImageGenerationRequestBackground](../models/imagegenerationrequestbackground.mdx) | :heavy_minus_sign: | Background treatment. `transparent` requires an output_format that supports alpha (png or webp). | auto | -| `inputReferences` | [models.ContentPartImage](../models/contentpartimage.mdx)[] | :heavy_minus_sign: | Reference images to guide image-to-image generation, as base64 data URLs or HTTP(S) URLs. | | +| `aspectRatio` | [models.ImageGenerationRequestAspectRatio](../models/imagegenerationrequestaspectratio) | :heavy_minus_sign: | Normalized aspect ratio of the generated image. Providers clamp to their supported subset. | 16:9 | +| `background` | [models.ImageGenerationRequestBackground](../models/imagegenerationrequestbackground) | :heavy_minus_sign: | Background treatment. `transparent` requires an output_format that supports alpha (png or webp). | auto | +| `inputReferences` | [models.ContentPartImage](../models/contentpartimage)[] | :heavy_minus_sign: | Reference images to guide image-to-image generation, as base64 data URLs or HTTP(S) URLs. | | | `model` | *string* | :heavy_check_mark: | The image generation model to use | bytedance-seed/seedream-4.5 | | `n` | *number* | :heavy_minus_sign: | Number of images to generate (1-10). Providers that only support single-image generation reject n > 1. | 1 | | `outputCompression` | *number* | :heavy_minus_sign: | Compression level (0-100) for webp/jpeg output. Ignored for png and by providers without a compression knob. | 100 | -| `outputFormat` | [models.ImageGenerationRequestOutputFormat](../models/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 | +| `outputFormat` | [models.ImageGenerationRequestOutputFormat](../models/imagegenerationrequestoutputformat) | :heavy_minus_sign: | Encoding of the returned image bytes. Most models produce raster formats (png, jpeg, webp). SVG is supported by vectorization models (e.g. Quiver) — the SVG markup is UTF-8 base64-encoded in `b64_json`. | png | | `prompt` | *string* | :heavy_check_mark: | Text description of the desired image | a red panda astronaut floating in space, studio lighting | -| `provider` | [models.ImageGenerationProviderPreferences](../models/imagegenerationproviderpreferences.mdx) | :heavy_minus_sign: | Provider routing preferences and provider-specific passthrough configuration. | \{
"allow_fallbacks": false,
"only": [
"google-ai-studio"
]
} | -| `quality` | [models.ImageGenerationRequestQuality](../models/imagegenerationrequestquality.mdx) | :heavy_minus_sign: | Rendering quality. Providers without a quality knob ignore this. | high | -| `resolution` | [models.ImageGenerationRequestResolution](../models/imagegenerationrequestresolution.mdx) | :heavy_minus_sign: | Normalized resolution tier of the generated image. Concrete pixel dimensions are derived per-provider. | 2K | +| `provider` | [models.ImageGenerationProviderPreferences](../models/imagegenerationproviderpreferences) | :heavy_minus_sign: | Provider routing preferences and provider-specific passthrough configuration. | \{
"allow_fallbacks": false,
"only": [
"google-ai-studio"
]
} | +| `quality` | [models.ImageGenerationRequestQuality](../models/imagegenerationrequestquality) | :heavy_minus_sign: | Rendering quality. Providers without a quality knob ignore this. | high | +| `resolution` | [models.ImageGenerationRequestResolution](../models/imagegenerationrequestresolution) | :heavy_minus_sign: | Normalized resolution tier of the generated image. Concrete pixel dimensions are derived per-provider. | 2K | | `seed` | *number* | :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. | | | `size` | *string* | :heavy_minus_sign: | Optional. A convenience shorthand for output dimensions — pass a tier ("2K", "4K") or explicit pixels ("2048x2048") and we normalize it to the right dimensions for the chosen provider. A tier size is equivalent to setting `resolution` and combines with `aspect_ratio`. An explicit pixel size is authoritative: a mismatched `resolution` or `aspect_ratio` alongside it is rejected with a 400. | 2K | | `stream` | *boolean* | :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. | | \ No newline at end of file diff --git a/docs/models/imagegenerationresponse.mdx b/docs/models/imagegenerationresponse.mdx index c4e00e3d6..895d6f123 100644 --- a/docs/models/imagegenerationresponse.mdx +++ b/docs/models/imagegenerationresponse.mdx @@ -24,5 +24,5 @@ let value: ImageGenerationResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `created` | *number* | :heavy_check_mark: | Unix timestamp (seconds) when the image was generated | 1748372400 | -| `data` | [models.ImageGenerationResponseData](../models/imagegenerationresponsedata.mdx)[] | :heavy_check_mark: | Generated images | | -| `usage` | [models.ImageGenerationUsage](../models/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 +| `data` | [models.ImageGenerationResponseData](../models/imagegenerationresponsedata)[] | :heavy_check_mark: | Generated images | | +| `usage` | [models.ImageGenerationUsage](../models/imagegenerationusage) | :heavy_minus_sign: | Token and cost usage for the image generation request, when available | \{
"completion_tokens": 4175,
"cost": 0.04,
"prompt_tokens": 0,
"total_tokens": 4175
} | \ No newline at end of file diff --git a/docs/models/imagegenerationservertool.mdx b/docs/models/imagegenerationservertool.mdx index bfbccf8e7..fb405c856 100644 --- a/docs/models/imagegenerationservertool.mdx +++ b/docs/models/imagegenerationservertool.mdx @@ -18,14 +18,14 @@ let value: ImageGenerationServerTool = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `background` | [models.ImageGenerationServerToolBackground](../models/imagegenerationservertoolbackground.mdx) | :heavy_minus_sign: | N/A | -| `inputFidelity` | [models.InputFidelity](../models/inputfidelity.mdx) | :heavy_minus_sign: | N/A | -| `inputImageMask` | [models.InputImageMask](../models/inputimagemask.mdx) | :heavy_minus_sign: | N/A | +| `background` | [models.ImageGenerationServerToolBackground](../models/imagegenerationservertoolbackground) | :heavy_minus_sign: | N/A | +| `inputFidelity` | [models.InputFidelity](../models/inputfidelity) | :heavy_minus_sign: | N/A | +| `inputImageMask` | [models.InputImageMask](../models/inputimagemask) | :heavy_minus_sign: | N/A | | `model` | *string* | :heavy_minus_sign: | N/A | -| `moderation` | [models.Moderation](../models/moderation.mdx) | :heavy_minus_sign: | N/A | +| `moderation` | [models.Moderation](../models/moderation) | :heavy_minus_sign: | N/A | | `outputCompression` | *number* | :heavy_minus_sign: | N/A | -| `outputFormat` | [models.ImageGenerationServerToolOutputFormat](../models/imagegenerationservertooloutputformat.mdx) | :heavy_minus_sign: | N/A | +| `outputFormat` | [models.ImageGenerationServerToolOutputFormat](../models/imagegenerationservertooloutputformat) | :heavy_minus_sign: | N/A | | `partialImages` | *number* | :heavy_minus_sign: | N/A | -| `quality` | [models.ImageGenerationServerToolQuality](../models/imagegenerationservertoolquality.mdx) | :heavy_minus_sign: | N/A | +| `quality` | [models.ImageGenerationServerToolQuality](../models/imagegenerationservertoolquality) | :heavy_minus_sign: | N/A | | `size` | *string* | :heavy_minus_sign: | N/A | -| `type` | [models.ImageGenerationServerToolType](../models/imagegenerationservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.ImageGenerationServerToolType](../models/imagegenerationservertooltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/imagegenerationservertoolopenrouter.mdx b/docs/models/imagegenerationservertoolopenrouter.mdx index ecf497e69..bb55616ee 100644 --- a/docs/models/imagegenerationservertoolopenrouter.mdx +++ b/docs/models/imagegenerationservertoolopenrouter.mdx @@ -18,5 +18,5 @@ let value: ImageGenerationServerToolOpenRouter = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `parameters` | [models.ImageGenerationServerToolConfig](../models/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` | [models.ImageGenerationServerToolOpenRouterType](../models/imagegenerationservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.ImageGenerationServerToolConfig](../models/imagegenerationservertoolconfig) | :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` | [models.ImageGenerationServerToolOpenRouterType](../models/imagegenerationservertoolopenroutertype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/imagegenerationusage.mdx b/docs/models/imagegenerationusage.mdx index 694f2529f..56c3f9a30 100644 --- a/docs/models/imagegenerationusage.mdx +++ b/docs/models/imagegenerationusage.mdx @@ -20,16 +20,16 @@ let value: ImageGenerationUsage = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `cacheCreation` | [models.AnthropicCacheCreation](../models/anthropiccachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | +| `cacheCreation` | [models.AnthropicCacheCreation](../models/anthropiccachecreation) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | | `completionTokens` | *number* | :heavy_check_mark: | The tokens generated | | -| `completionTokensDetails` | [models.ImageGenerationUsageCompletionTokensDetails](../models/imagegenerationusagecompletiontokensdetails.mdx) | :heavy_minus_sign: | N/A | | +| `completionTokensDetails` | [models.ImageGenerationUsageCompletionTokensDetails](../models/imagegenerationusagecompletiontokensdetails) | :heavy_minus_sign: | N/A | | | `cost` | *number* | :heavy_minus_sign: | Cost of the completion | | -| `costDetails` | [models.CostDetails](../models/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
} | +| `costDetails` | [models.CostDetails](../models/costdetails) | :heavy_minus_sign: | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | | `isByok` | *boolean* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | | `iterations` | *models.AnthropicUsageIteration*[] | :heavy_minus_sign: | N/A | | | `promptTokens` | *number* | :heavy_check_mark: | Including images, input audio, and tools if any | | -| `promptTokensDetails` | [models.ImageGenerationUsagePromptTokensDetails](../models/imagegenerationusageprompttokensdetails.mdx) | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | | -| `serverToolUse` | [models.ServerToolUse](../models/servertooluse.mdx) | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | | +| `promptTokensDetails` | [models.ImageGenerationUsagePromptTokensDetails](../models/imagegenerationusageprompttokensdetails) | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | | +| `serverToolUse` | [models.ServerToolUse](../models/servertooluse) | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | | | `serviceTier` | *string* | :heavy_minus_sign: | The service tier used by the upstream provider for this request | | -| `speed` | [models.AnthropicSpeed](../models/anthropicspeed.mdx) | :heavy_minus_sign: | N/A | standard | +| `speed` | [models.AnthropicSpeed](../models/anthropicspeed) | :heavy_minus_sign: | N/A | standard | | `totalTokens` | *number* | :heavy_check_mark: | Sum of the above two fields | | \ No newline at end of file diff --git a/docs/models/imagegenstreamerrorevent.mdx b/docs/models/imagegenstreamerrorevent.mdx index ded909b38..1cb355c31 100644 --- a/docs/models/imagegenstreamerrorevent.mdx +++ b/docs/models/imagegenstreamerrorevent.mdx @@ -21,5 +21,5 @@ let value: ImageGenStreamErrorEvent = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `error` | [models.ImageGenStreamErrorEventError](../models/imagegenstreamerroreventerror.mdx) | :heavy_check_mark: | Provider error details | +| `error` | [models.ImageGenStreamErrorEventError](../models/imagegenstreamerroreventerror) | :heavy_check_mark: | Provider error details | | `type` | *"error"* | :heavy_check_mark: | The event type | \ No newline at end of file diff --git a/docs/models/imagegentextchunkevent.mdx b/docs/models/imagegentextchunkevent.mdx index 4e429b1c2..97d3eac5a 100644 --- a/docs/models/imagegentextchunkevent.mdx +++ b/docs/models/imagegentextchunkevent.mdx @@ -20,6 +20,6 @@ let value: ImageGenTextChunkEvent = { | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `phase` | [models.ImageGenTextChunkEventPhase](../models/imagegentextchunkeventphase.mdx) | :heavy_check_mark: | The generation phase this chunk belongs to. `content` is the renderable output; `reasoning` and `draft` are intermediate provider phases. | +| `phase` | [models.ImageGenTextChunkEventPhase](../models/imagegentextchunkeventphase) | :heavy_check_mark: | The generation phase this chunk belongs to. `content` is the renderable output; `reasoning` and `draft` are intermediate provider phases. | | `text` | *string* | :heavy_check_mark: | A text fragment of the image being generated (e.g. partial SVG markup) | | `type` | *"image_generation.text_chunk"* | :heavy_check_mark: | The event type | \ No newline at end of file diff --git a/docs/models/imagemodelarchitecture.mdx b/docs/models/imagemodelarchitecture.mdx index 73c1ce6e6..14b7591e1 100644 --- a/docs/models/imagemodelarchitecture.mdx +++ b/docs/models/imagemodelarchitecture.mdx @@ -22,5 +22,5 @@ let value: ImageModelArchitecture = { | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `inputModalities` | [models.ImageInputModality](../models/imageinputmodality.mdx)[] | :heavy_check_mark: | Supported input modalities | -| `outputModalities` | [models.ImageOutputModality](../models/imageoutputmodality.mdx)[] | :heavy_check_mark: | Supported output modalities | \ No newline at end of file +| `inputModalities` | [models.ImageInputModality](../models/imageinputmodality)[] | :heavy_check_mark: | Supported input modalities | +| `outputModalities` | [models.ImageOutputModality](../models/imageoutputmodality)[] | :heavy_check_mark: | Supported output modalities | \ No newline at end of file diff --git a/docs/models/imagemodelendpointsresponse.mdx b/docs/models/imagemodelendpointsresponse.mdx index e02092521..0452d9c8d 100644 --- a/docs/models/imagemodelendpointsresponse.mdx +++ b/docs/models/imagemodelendpointsresponse.mdx @@ -44,5 +44,5 @@ let value: ImageModelEndpointsResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `endpoints` | [models.ImageEndpoint](../models/imageendpoint.mdx)[] | :heavy_check_mark: | N/A | | +| `endpoints` | [models.ImageEndpoint](../models/imageendpoint)[] | :heavy_check_mark: | N/A | | | `id` | *string* | :heavy_check_mark: | Model slug | bytedance-seed/seedream-4.5 | \ No newline at end of file diff --git a/docs/models/imagemodellistitem.mdx b/docs/models/imagemodellistitem.mdx index 6ee6cf8b3..9cb76615e 100644 --- a/docs/models/imagemodellistitem.mdx +++ b/docs/models/imagemodellistitem.mdx @@ -45,7 +45,7 @@ let value: ImageModelListItem = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `architecture` | [models.ImageModelArchitecture](../models/imagemodelarchitecture.mdx) | :heavy_check_mark: | N/A | \{
"input_modalities": [
"text",
"image"
],
"output_modalities": [
"image"
]
} | +| `architecture` | [models.ImageModelArchitecture](../models/imagemodelarchitecture) | :heavy_check_mark: | N/A | \{
"input_modalities": [
"text",
"image"
],
"output_modalities": [
"image"
]
} | | `created` | *number* | :heavy_check_mark: | Unix timestamp (seconds) of when the model was created | 1692901234 | | `description` | *string* | :heavy_check_mark: | N/A | A text-to-image model. | | `endpoints` | *string* | :heavy_check_mark: | Relative URL to the full per-endpoint records for this model | /api/v1/images/models/bytedance-seed/seedream-4.5/endpoints | diff --git a/docs/models/imagemodelslistresponse.mdx b/docs/models/imagemodelslistresponse.mdx index 3c3e59192..c29b0a1b9 100644 --- a/docs/models/imagemodelslistresponse.mdx +++ b/docs/models/imagemodelslistresponse.mdx @@ -45,4 +45,4 @@ let value: ImageModelsListResponse = { | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `data` | [models.ImageModelListItem](../models/imagemodellistitem.mdx)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [models.ImageModelListItem](../models/imagemodellistitem)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/imagepricingentry.mdx b/docs/models/imagepricingentry.mdx index 08b475de2..358501b05 100644 --- a/docs/models/imagepricingentry.mdx +++ b/docs/models/imagepricingentry.mdx @@ -20,7 +20,7 @@ let value: ImagePricingEntry = { | Field | Type | Required | Description | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `billable` | [models.Billable](../models/billable.mdx) | :heavy_check_mark: | N/A | +| `billable` | [models.Billable](../models/billable) | :heavy_check_mark: | N/A | | `costUsd` | *number* | :heavy_check_mark: | N/A | -| `unit` | [models.Unit](../models/unit.mdx) | :heavy_check_mark: | N/A | +| `unit` | [models.Unit](../models/unit) | :heavy_check_mark: | N/A | | `variant` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/incompletedetails.mdx b/docs/models/incompletedetails.mdx index 29e8ed28a..e36afc382 100644 --- a/docs/models/incompletedetails.mdx +++ b/docs/models/incompletedetails.mdx @@ -14,4 +14,4 @@ let value: IncompleteDetails = {}; | Field | Type | Required | Description | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `reason` | [models.Reason](../models/reason.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `reason` | [models.Reason](../models/reason) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/inputaudio.mdx b/docs/models/inputaudio.mdx index eddc78187..15ea810b3 100644 --- a/docs/models/inputaudio.mdx +++ b/docs/models/inputaudio.mdx @@ -22,5 +22,5 @@ let value: InputAudio = { | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `inputAudio` | [models.InputAudioInputAudio](../models/inputaudioinputaudio.mdx) | :heavy_check_mark: | N/A | +| `inputAudio` | [models.InputAudioInputAudio](../models/inputaudioinputaudio) | :heavy_check_mark: | N/A | | `type` | *"input_audio"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/inputaudioinputaudio.mdx b/docs/models/inputaudioinputaudio.mdx index 882e53d96..505d8b596 100644 --- a/docs/models/inputaudioinputaudio.mdx +++ b/docs/models/inputaudioinputaudio.mdx @@ -18,4 +18,4 @@ let value: InputAudioInputAudio = { | Field | Type | Required | Description | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | | `data` | *string* | :heavy_check_mark: | N/A | -| `format` | [models.FormatEnum](../models/formatenum.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `format` | [models.FormatEnum](../models/formatenum) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/inputimage.mdx b/docs/models/inputimage.mdx index f4834a575..609e15972 100644 --- a/docs/models/inputimage.mdx +++ b/docs/models/inputimage.mdx @@ -19,6 +19,6 @@ let value: InputImage = { | Field | Type | Required | Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `detail` | [models.InputImageDetail](../models/inputimagedetail.mdx) | :heavy_check_mark: | N/A | +| `detail` | [models.InputImageDetail](../models/inputimagedetail) | :heavy_check_mark: | N/A | | `imageUrl` | *string* | :heavy_minus_sign: | N/A | -| `type` | [models.InputImageTypeEnum](../models/inputimagetypeenum.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.InputImageTypeEnum](../models/inputimagetypeenum) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/inputmessageitem.mdx b/docs/models/inputmessageitem.mdx index e72d1dc90..eb7b81139 100644 --- a/docs/models/inputmessageitem.mdx +++ b/docs/models/inputmessageitem.mdx @@ -19,4 +19,4 @@ let value: InputMessageItem = { | `content` | *models.InputMessageItemContentUnion*[] | :heavy_minus_sign: | N/A | | `id` | *string* | :heavy_minus_sign: | N/A | | `role` | *models.InputMessageItemRoleUnion* | :heavy_check_mark: | N/A | -| `type` | [models.InputMessageItemTypeMessage](../models/inputmessageitemtypemessage.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | [models.InputMessageItemTypeMessage](../models/inputmessageitemtypemessage) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/inputmessageitemcontentinputimage.mdx b/docs/models/inputmessageitemcontentinputimage.mdx index e89d58db6..e5b59afe5 100644 --- a/docs/models/inputmessageitemcontentinputimage.mdx +++ b/docs/models/inputmessageitemcontentinputimage.mdx @@ -19,6 +19,6 @@ let value: InputMessageItemContentInputImage = { | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `detail` | [models.InputMessageItemDetail](../models/inputmessageitemdetail.mdx) | :heavy_check_mark: | N/A | +| `detail` | [models.InputMessageItemDetail](../models/inputmessageitemdetail) | :heavy_check_mark: | N/A | | `imageUrl` | *string* | :heavy_minus_sign: | N/A | | `type` | *"input_image"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/inputsmessage.mdx b/docs/models/inputsmessage.mdx index f1fbb8097..5af795faa 100644 --- a/docs/models/inputsmessage.mdx +++ b/docs/models/inputsmessage.mdx @@ -29,6 +29,6 @@ let value: InputsMessage = { | `content` | *models.InputsContent2* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | | `phase` | *models.InputsPhaseUnion* | :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` | [models.InputsRole](../models/inputsrole.mdx) | :heavy_check_mark: | N/A | +| `role` | [models.InputsRole](../models/inputsrole) | :heavy_check_mark: | N/A | | `status` | *models.InputsStatusUnion1* | :heavy_minus_sign: | N/A | -| `type` | [models.InputsTypeMessage](../models/inputstypemessage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.InputsTypeMessage](../models/inputstypemessage) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/inputsreasoning.mdx b/docs/models/inputsreasoning.mdx index a578b2f3a..5a06ba977 100644 --- a/docs/models/inputsreasoning.mdx +++ b/docs/models/inputsreasoning.mdx @@ -25,11 +25,11 @@ let value: InputsReasoning = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `content` | [models.ReasoningTextContent](../models/reasoningtextcontent.mdx)[] | :heavy_minus_sign: | N/A | | +| `content` | [models.ReasoningTextContent](../models/reasoningtextcontent)[] | :heavy_minus_sign: | N/A | | | `encryptedContent` | *string* | :heavy_minus_sign: | N/A | | | `id` | *string* | :heavy_check_mark: | N/A | | | `status` | *models.InputsStatusUnion2* | :heavy_minus_sign: | N/A | | -| `summary` | [models.ReasoningSummaryText](../models/reasoningsummarytext.mdx)[] | :heavy_check_mark: | N/A | | -| `type` | [models.InputsTypeReasoning](../models/inputstypereasoning.mdx) | :heavy_check_mark: | N/A | | -| `format` | [models.ReasoningFormat](../models/reasoningformat.mdx) | :heavy_minus_sign: | N/A | unknown | +| `summary` | [models.ReasoningSummaryText](../models/reasoningsummarytext)[] | :heavy_check_mark: | N/A | | +| `type` | [models.InputsTypeReasoning](../models/inputstypereasoning) | :heavy_check_mark: | N/A | | +| `format` | [models.ReasoningFormat](../models/reasoningformat) | :heavy_minus_sign: | N/A | unknown | | `signature` | *string* | :heavy_minus_sign: | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | \ No newline at end of file diff --git a/docs/models/inputtext.mdx b/docs/models/inputtext.mdx index 285d10e5c..6f4b1d79d 100644 --- a/docs/models/inputtext.mdx +++ b/docs/models/inputtext.mdx @@ -19,6 +19,6 @@ let value: InputText = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `promptCacheBreakpoint` | [models.PromptCacheBreakpoint](../models/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"
} | +| `promptCacheBreakpoint` | [models.PromptCacheBreakpoint](../models/promptcachebreakpoint) | :heavy_minus_sign: | Marks an explicit prompt-cache boundary on this content block (OpenAI-style). Everything through the block carrying this marker is part of the candidate cached prefix. Supported natively by OpenAI GPT-5.6 and newer; on providers that use Anthropic-style `cache_control`, OpenRouter converts the marker to that format automatically. | \{
"mode": "explicit"
} | | `text` | *string* | :heavy_check_mark: | N/A | | | `type` | *"input_text"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/itemreferenceitem.mdx b/docs/models/itemreferenceitem.mdx index 21defedc9..2d69e7396 100644 --- a/docs/models/itemreferenceitem.mdx +++ b/docs/models/itemreferenceitem.mdx @@ -20,4 +20,4 @@ let value: ItemReferenceItem = { | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.ItemReferenceItemType](../models/itemreferenceitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.ItemReferenceItemType](../models/itemreferenceitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/keepall.mdx b/docs/models/keepall.mdx index 6fc61f5f9..076c13272 100644 --- a/docs/models/keepall.mdx +++ b/docs/models/keepall.mdx @@ -16,4 +16,4 @@ let value: KeepAll = { | Field | Type | Required | Description | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `type` | [models.KeepType](../models/keeptype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.KeepType](../models/keeptype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/legacychatcontentvideo.mdx b/docs/models/legacychatcontentvideo.mdx index 6352b0bf6..672bdd940 100644 --- a/docs/models/legacychatcontentvideo.mdx +++ b/docs/models/legacychatcontentvideo.mdx @@ -24,4 +24,4 @@ let value: LegacyChatContentVideo = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | | `type` | *"input_video"* | :heavy_check_mark: | N/A | | -| `videoUrl` | [models.LegacyChatContentVideoInput](../models/legacychatcontentvideoinput.mdx) | :heavy_check_mark: | Video input object | \{
"url": "https://example.com/video.mp4"
} | \ No newline at end of file +| `videoUrl` | [models.LegacyChatContentVideoInput](../models/legacychatcontentvideoinput) | :heavy_check_mark: | Video input object | \{
"url": "https://example.com/video.mp4"
} | \ No newline at end of file diff --git a/docs/models/legacywebsearchservertool.mdx b/docs/models/legacywebsearchservertool.mdx index a87f05268..24e7c2d92 100644 --- a/docs/models/legacywebsearchservertool.mdx +++ b/docs/models/legacywebsearchservertool.mdx @@ -18,10 +18,10 @@ let value: LegacyWebSearchServerTool = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `engine` | [models.WebSearchEngineEnum](../models/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` | [models.WebSearchDomainFilter](../models/websearchdomainfilter.mdx) | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | +| `engine` | [models.WebSearchEngineEnum](../models/websearchengineenum) | :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` | [models.WebSearchDomainFilter](../models/websearchdomainfilter) | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | | `maxResults` | *number* | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | | `maxUses` | *number* | :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 | -| `searchContextSize` | [models.SearchContextSizeEnum](../models/searchcontextsizeenum.mdx) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `type` | [models.LegacyWebSearchServerToolType](../models/legacywebsearchservertooltype.mdx) | :heavy_check_mark: | N/A | | -| `userLocation` | [models.WebSearchUserLocation](../models/websearchuserlocation.mdx) | :heavy_minus_sign: | User location information for web search | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file +| `searchContextSize` | [models.SearchContextSizeEnum](../models/searchcontextsizeenum) | :heavy_minus_sign: | Size of the search context for web search tools | medium | +| `type` | [models.LegacyWebSearchServerToolType](../models/legacywebsearchservertooltype) | :heavy_check_mark: | N/A | | +| `userLocation` | [models.WebSearchUserLocation](../models/websearchuserlocation) | :heavy_minus_sign: | User location information for web search | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file diff --git a/docs/models/listbyokkeysresponse.mdx b/docs/models/listbyokkeysresponse.mdx index dda39ed8d..8b46bd3b4 100644 --- a/docs/models/listbyokkeysresponse.mdx +++ b/docs/models/listbyokkeysresponse.mdx @@ -31,5 +31,5 @@ let value: ListBYOKKeysResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `data` | [models.BYOKKey](../models/byokkey.mdx)[] | :heavy_check_mark: | List of BYOK credentials. | | +| `data` | [models.BYOKKey](../models/byokkey)[] | :heavy_check_mark: | List of BYOK credentials. | | | `totalCount` | *number* | :heavy_check_mark: | Total number of BYOK credentials matching the filters. | 1 | \ No newline at end of file diff --git a/docs/models/listendpointsresponse.mdx b/docs/models/listendpointsresponse.mdx index 8e2fe1316..0dadda90d 100644 --- a/docs/models/listendpointsresponse.mdx +++ b/docs/models/listendpointsresponse.mdx @@ -73,9 +73,9 @@ let value: ListEndpointsResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `architecture` | [models.Architecture](../models/architecture.mdx) | :heavy_check_mark: | N/A | \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
} | +| `architecture` | [models.Architecture](../models/architecture) | :heavy_check_mark: | N/A | \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
} | | `created` | *number* | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | | `description` | *string* | :heavy_check_mark: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | -| `endpoints` | [models.PublicEndpoint](../models/publicendpoint.mdx)[] | :heavy_check_mark: | List of available endpoints for this model | | +| `endpoints` | [models.PublicEndpoint](../models/publicendpoint)[] | :heavy_check_mark: | List of available endpoints for this model | | | `id` | *string* | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 | | `name` | *string* | :heavy_check_mark: | Display name of the model | GPT-4 | \ No newline at end of file diff --git a/docs/models/listguardrailsresponse.mdx b/docs/models/listguardrailsresponse.mdx index 4ea4eb8bd..c2f21ef79 100644 --- a/docs/models/listguardrailsresponse.mdx +++ b/docs/models/listguardrailsresponse.mdx @@ -25,5 +25,5 @@ let value: ListGuardrailsResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `data` | [models.Guardrail](../models/guardrail.mdx)[] | :heavy_check_mark: | List of guardrails | | +| `data` | [models.Guardrail](../models/guardrail)[] | :heavy_check_mark: | List of guardrails | | | `totalCount` | *number* | :heavy_check_mark: | Total number of guardrails | 25 | \ No newline at end of file diff --git a/docs/models/listkeyassignmentsresponse.mdx b/docs/models/listkeyassignmentsresponse.mdx index 8b8926f86..2760e962b 100644 --- a/docs/models/listkeyassignmentsresponse.mdx +++ b/docs/models/listkeyassignmentsresponse.mdx @@ -28,5 +28,5 @@ let value: ListKeyAssignmentsResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `data` | [models.KeyAssignment](../models/keyassignment.mdx)[] | :heavy_check_mark: | List of key assignments | | +| `data` | [models.KeyAssignment](../models/keyassignment)[] | :heavy_check_mark: | List of key assignments | | | `totalCount` | *number* | :heavy_check_mark: | Total number of key assignments for this guardrail | 25 | \ No newline at end of file diff --git a/docs/models/listmemberassignmentsresponse.mdx b/docs/models/listmemberassignmentsresponse.mdx index 548abff2e..491939fe6 100644 --- a/docs/models/listmemberassignmentsresponse.mdx +++ b/docs/models/listmemberassignmentsresponse.mdx @@ -26,5 +26,5 @@ let value: ListMemberAssignmentsResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `data` | [models.MemberAssignment](../models/memberassignment.mdx)[] | :heavy_check_mark: | List of member assignments | | +| `data` | [models.MemberAssignment](../models/memberassignment)[] | :heavy_check_mark: | List of member assignments | | | `totalCount` | *number* | :heavy_check_mark: | Total number of member assignments | 10 | \ No newline at end of file diff --git a/docs/models/listpresetsresponse.mdx b/docs/models/listpresetsresponse.mdx index 932bd2e1c..4dce5ec50 100644 --- a/docs/models/listpresetsresponse.mdx +++ b/docs/models/listpresetsresponse.mdx @@ -33,5 +33,5 @@ let value: ListPresetsResponse = { | Field | Type | Required | Description | | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `data` | [models.Preset](../models/preset.mdx)[] | :heavy_check_mark: | N/A | +| `data` | [models.Preset](../models/preset)[] | :heavy_check_mark: | N/A | | `totalCount` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/listpresetversionsresponse.mdx b/docs/models/listpresetversionsresponse.mdx index 5efa47c6a..97b0e8e30 100644 --- a/docs/models/listpresetversionsresponse.mdx +++ b/docs/models/listpresetversionsresponse.mdx @@ -33,5 +33,5 @@ let value: ListPresetVersionsResponse = { | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `data` | [models.PresetDesignatedVersion](../models/presetdesignatedversion.mdx)[] | :heavy_check_mark: | N/A | +| `data` | [models.PresetDesignatedVersion](../models/presetdesignatedversion)[] | :heavy_check_mark: | N/A | | `totalCount` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/listworkspacebudgetsresponse.mdx b/docs/models/listworkspacebudgetsresponse.mdx index 885c9225a..0300af790 100644 --- a/docs/models/listworkspacebudgetsresponse.mdx +++ b/docs/models/listworkspacebudgetsresponse.mdx @@ -25,4 +25,4 @@ let value: ListWorkspaceBudgetsResponse = { | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `data` | [models.WorkspaceBudget](../models/workspacebudget.mdx)[] | :heavy_check_mark: | List of budgets configured for the workspace | \ No newline at end of file +| `data` | [models.WorkspaceBudget](../models/workspacebudget)[] | :heavy_check_mark: | List of budgets configured for the workspace | \ No newline at end of file diff --git a/docs/models/listworkspacemembersresponse.mdx b/docs/models/listworkspacemembersresponse.mdx index fc28a3bef..84f7013ba 100644 --- a/docs/models/listworkspacemembersresponse.mdx +++ b/docs/models/listworkspacemembersresponse.mdx @@ -25,5 +25,5 @@ let value: ListWorkspaceMembersResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `data` | [models.WorkspaceMember](../models/workspacemember.mdx)[] | :heavy_check_mark: | List of workspace members | | +| `data` | [models.WorkspaceMember](../models/workspacemember)[] | :heavy_check_mark: | List of workspace members | | | `totalCount` | *number* | :heavy_check_mark: | Total number of members in the workspace | 5 | \ No newline at end of file diff --git a/docs/models/listworkspacesresponse.mdx b/docs/models/listworkspacesresponse.mdx index 419b443e1..ef5ac65e1 100644 --- a/docs/models/listworkspacesresponse.mdx +++ b/docs/models/listworkspacesresponse.mdx @@ -36,5 +36,5 @@ let value: ListWorkspacesResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `data` | [models.Workspace](../models/workspace.mdx)[] | :heavy_check_mark: | List of workspaces | | +| `data` | [models.Workspace](../models/workspace)[] | :heavy_check_mark: | List of workspaces | | | `totalCount` | *number* | :heavy_check_mark: | Total number of workspaces | 5 | \ No newline at end of file diff --git a/docs/models/localshellcallitem.mdx b/docs/models/localshellcallitem.mdx index 37dc59e85..06b3d0f79 100644 --- a/docs/models/localshellcallitem.mdx +++ b/docs/models/localshellcallitem.mdx @@ -31,8 +31,8 @@ let value: LocalShellCallItem = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `action` | [models.LocalShellCallItemAction](../models/localshellcallitemaction.mdx) | :heavy_check_mark: | N/A | | +| `action` | [models.LocalShellCallItemAction](../models/localshellcallitemaction) | :heavy_check_mark: | N/A | | | `callId` | *string* | :heavy_check_mark: | N/A | | | `id` | *string* | :heavy_check_mark: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.TypeLocalShellCall](../models/typelocalshellcall.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `status` | [models.ToolCallStatus](../models/toolcallstatus) | :heavy_check_mark: | N/A | completed | +| `type` | [models.TypeLocalShellCall](../models/typelocalshellcall) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/localshellcallitemaction.mdx b/docs/models/localshellcallitemaction.mdx index 6612238f1..a1234041b 100644 --- a/docs/models/localshellcallitemaction.mdx +++ b/docs/models/localshellcallitemaction.mdx @@ -23,6 +23,6 @@ let value: LocalShellCallItemAction = { | `command` | *string*[] | :heavy_check_mark: | N/A | | `env` | Record\ | :heavy_check_mark: | N/A | | `timeoutMs` | *number* | :heavy_minus_sign: | N/A | -| `type` | [models.TypeExec](../models/typeexec.mdx) | :heavy_check_mark: | N/A | +| `type` | [models.TypeExec](../models/typeexec) | :heavy_check_mark: | N/A | | `user` | *string* | :heavy_minus_sign: | N/A | | `workingDirectory` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/localshellcalloutputitem.mdx b/docs/models/localshellcalloutputitem.mdx index ebf1237b6..a945d823a 100644 --- a/docs/models/localshellcalloutputitem.mdx +++ b/docs/models/localshellcalloutputitem.mdx @@ -22,5 +22,5 @@ let value: LocalShellCallOutputItem = { | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | | `id` | *string* | :heavy_check_mark: | N/A | | | `output` | *string* | :heavy_check_mark: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | -| `type` | [models.LocalShellCallOutputItemType](../models/localshellcalloutputitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `status` | [models.ToolCallStatus](../models/toolcallstatus) | :heavy_minus_sign: | N/A | completed | +| `type` | [models.LocalShellCallOutputItemType](../models/localshellcalloutputitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/logprob.mdx b/docs/models/logprob.mdx index 22564067b..e986c5b8f 100644 --- a/docs/models/logprob.mdx +++ b/docs/models/logprob.mdx @@ -24,4 +24,4 @@ let value: Logprob = { | `bytes` | *number*[] | :heavy_check_mark: | N/A | | `logprob` | *number* | :heavy_check_mark: | N/A | | `token` | *string* | :heavy_check_mark: | N/A | -| `topLogprobs` | [models.ResponseOutputTextTopLogprob](../models/responseoutputtexttoplogprob.mdx)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `topLogprobs` | [models.ResponseOutputTextTopLogprob](../models/responseoutputtexttoplogprob)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/mcpapprovalrequestitem.mdx b/docs/models/mcpapprovalrequestitem.mdx index f224845b5..1cea0a5e8 100644 --- a/docs/models/mcpapprovalrequestitem.mdx +++ b/docs/models/mcpapprovalrequestitem.mdx @@ -26,4 +26,4 @@ let value: McpApprovalRequestItem = { | `id` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_check_mark: | N/A | | `serverLabel` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.McpApprovalRequestItemType](../models/mcpapprovalrequestitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.McpApprovalRequestItemType](../models/mcpapprovalrequestitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/mcpapprovalresponseitem.mdx b/docs/models/mcpapprovalresponseitem.mdx index b26c49657..2548ad66e 100644 --- a/docs/models/mcpapprovalresponseitem.mdx +++ b/docs/models/mcpapprovalresponseitem.mdx @@ -24,4 +24,4 @@ let value: McpApprovalResponseItem = { | `approve` | *boolean* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_minus_sign: | N/A | | `reason` | *string* | :heavy_minus_sign: | N/A | -| `type` | [models.McpApprovalResponseItemType](../models/mcpapprovalresponseitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.McpApprovalResponseItemType](../models/mcpapprovalresponseitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/mcpcallitem.mdx b/docs/models/mcpcallitem.mdx index 64ee9ed0c..5ba950601 100644 --- a/docs/models/mcpcallitem.mdx +++ b/docs/models/mcpcallitem.mdx @@ -28,4 +28,4 @@ let value: McpCallItem = { | `name` | *string* | :heavy_check_mark: | N/A | | `output` | *string* | :heavy_minus_sign: | N/A | | `serverLabel` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.McpCallItemType](../models/mcpcallitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.McpCallItemType](../models/mcpcallitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/mcplisttoolsitem.mdx b/docs/models/mcplisttoolsitem.mdx index d4f41f75a..b93de72d6 100644 --- a/docs/models/mcplisttoolsitem.mdx +++ b/docs/models/mcplisttoolsitem.mdx @@ -36,5 +36,5 @@ let value: McpListToolsItem = { | `error` | *string* | :heavy_minus_sign: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | | `serverLabel` | *string* | :heavy_check_mark: | N/A | -| `tools` | [models.McpListToolsItemTool](../models/mcplisttoolsitemtool.mdx)[] | :heavy_check_mark: | N/A | -| `type` | [models.McpListToolsItemType](../models/mcplisttoolsitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `tools` | [models.McpListToolsItemTool](../models/mcplisttoolsitemtool)[] | :heavy_check_mark: | N/A | +| `type` | [models.McpListToolsItemType](../models/mcplisttoolsitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/mcpservertool.mdx b/docs/models/mcpservertool.mdx index e7b401c6b..bc703428b 100644 --- a/docs/models/mcpservertool.mdx +++ b/docs/models/mcpservertool.mdx @@ -21,10 +21,10 @@ let value: McpServerTool = { | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | | `allowedTools` | *models.AllowedToolsUnion* | :heavy_minus_sign: | N/A | | `authorization` | *string* | :heavy_minus_sign: | N/A | -| `connectorId` | [models.ConnectorId](../models/connectorid.mdx) | :heavy_minus_sign: | N/A | +| `connectorId` | [models.ConnectorId](../models/connectorid) | :heavy_minus_sign: | N/A | | `headers` | Record\ | :heavy_minus_sign: | N/A | | `requireApproval` | *models.RequireApprovalUnion* | :heavy_minus_sign: | N/A | | `serverDescription` | *string* | :heavy_minus_sign: | N/A | | `serverLabel` | *string* | :heavy_check_mark: | N/A | | `serverUrl` | *string* | :heavy_minus_sign: | N/A | -| `type` | [models.McpServerToolType](../models/mcpservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.McpServerToolType](../models/mcpservertooltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/messagesmessageparam.mdx b/docs/models/messagesmessageparam.mdx index e7e89c534..f2b86377e 100644 --- a/docs/models/messagesmessageparam.mdx +++ b/docs/models/messagesmessageparam.mdx @@ -20,4 +20,4 @@ let value: MessagesMessageParam = { | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | | `content` | *models.MessagesMessageParamContentUnion5* | :heavy_check_mark: | N/A | -| `role` | [models.MessagesMessageParamRole](../models/messagesmessageparamrole.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `role` | [models.MessagesMessageParamRole](../models/messagesmessageparamrole) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/messagesoutputconfig.mdx b/docs/models/messagesoutputconfig.mdx index 14573c947..99a0c9622 100644 --- a/docs/models/messagesoutputconfig.mdx +++ b/docs/models/messagesoutputconfig.mdx @@ -16,6 +16,6 @@ let value: MessagesOutputConfig = {}; | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `effort` | [models.MessagesOutputConfigEffort](../models/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` | [models.MessagesOutputConfigFormat](../models/messagesoutputconfigformat.mdx) | :heavy_minus_sign: | A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs). | | -| `taskBudget` | [models.TaskBudget](../models/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` | [models.MessagesOutputConfigEffort](../models/messagesoutputconfigeffort) | :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` | [models.MessagesOutputConfigFormat](../models/messagesoutputconfigformat) | :heavy_minus_sign: | A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs). | | +| `taskBudget` | [models.TaskBudget](../models/taskbudget) | :heavy_minus_sign: | Task budget for an agentic turn. The model sees a countdown of remaining tokens and uses it to prioritize work and wind down gracefully. Advisory — does not enforce a hard cap. | \{
"total": 400000,
"type": "tokens"
} | \ No newline at end of file diff --git a/docs/models/messagesoutputconfigformat.mdx b/docs/models/messagesoutputconfigformat.mdx index 367dfbc74..b7c67a937 100644 --- a/docs/models/messagesoutputconfigformat.mdx +++ b/docs/models/messagesoutputconfigformat.mdx @@ -20,4 +20,4 @@ let value: MessagesOutputConfigFormat = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | | `schema` | Record\ | :heavy_check_mark: | N/A | -| `type` | [models.MessagesOutputConfigTypeJSONSchema](../models/messagesoutputconfigtypejsonschema.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.MessagesOutputConfigTypeJSONSchema](../models/messagesoutputconfigtypejsonschema) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/messagesrequest.mdx b/docs/models/messagesrequest.mdx index 6d258c479..88e1a9c95 100644 --- a/docs/models/messagesrequest.mdx +++ b/docs/models/messagesrequest.mdx @@ -24,20 +24,20 @@ let value: MessagesRequest = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `contextManagement` | [models.ContextManagement](../models/contextmanagement.mdx) | :heavy_minus_sign: | N/A | | -| `fallbacks` | [models.MessagesFallbackParam](../models/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"
}
] | +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `contextManagement` | [models.ContextManagement](../models/contextmanagement) | :heavy_minus_sign: | N/A | | +| `fallbacks` | [models.MessagesFallbackParam](../models/messagesfallbackparam)[] | :heavy_minus_sign: | Fallback models to try if the primary model fails or refuses, in order. Handled by OpenRouter multi-model routing rather than Anthropic server-side fallbacks; cannot be combined with `models`. Each entry accepts only `model`. Maximum of 3 entries. | [
\{
"model": "claude-opus-4-8"
}
] | | `maxTokens` | *number* | :heavy_minus_sign: | N/A | | -| `messages` | [models.MessagesMessageParam](../models/messagesmessageparam.mdx)[] | :heavy_check_mark: | N/A | | -| `metadata` | [models.MessagesRequestMetadata](../models/messagesrequestmetadata.mdx) | :heavy_minus_sign: | N/A | | +| `messages` | [models.MessagesMessageParam](../models/messagesmessageparam)[] | :heavy_check_mark: | N/A | | +| `metadata` | [models.MessagesRequestMetadata](../models/messagesrequestmetadata) | :heavy_minus_sign: | N/A | | | `model` | *string* | :heavy_check_mark: | N/A | | | `models` | *string*[] | :heavy_minus_sign: | N/A | | -| `outputConfig` | [models.MessagesOutputConfig](../models/messagesoutputconfig.mdx) | :heavy_minus_sign: | Configuration for controlling output behavior. Supports the effort parameter and structured output format. | \{
"effort": "medium"
} | +| `outputConfig` | [models.MessagesOutputConfig](../models/messagesoutputconfig) | :heavy_minus_sign: | Configuration for controlling output behavior. Supports the effort parameter and structured output format. | \{
"effort": "medium"
} | | `plugins` | *models.MessagesRequestPlugin*[] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `provider` | [models.ProviderPreferences](../models/providerpreferences.mdx) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `provider` | [models.ProviderPreferences](../models/providerpreferences) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | | `serviceTier` | *string* | :heavy_minus_sign: | N/A | | | `sessionId` | *string* | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). When provided, OpenRouter uses it as the sticky routing key, routing all requests in the session to the same provider to maximize prompt cache hits. Also used for observability grouping. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | | -| `speed` | [models.Speed](../models/speed.mdx) | :heavy_minus_sign: | N/A | fast | +| `speed` | [models.Speed](../models/speed) | :heavy_minus_sign: | N/A | fast | | `stopSequences` | *string*[] | :heavy_minus_sign: | N/A | | | `stopServerToolsWhen` | *models.StopServerToolsWhenCondition*[] | :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` | *boolean* | :heavy_minus_sign: | N/A | | @@ -48,5 +48,5 @@ let value: MessagesRequest = { | `tools` | *models.MessagesRequestToolUnion*[] | :heavy_minus_sign: | N/A | | | `topK` | *number* | :heavy_minus_sign: | N/A | | | `topP` | *number* | :heavy_minus_sign: | N/A | | -| `trace` | [models.TraceConfig](../models/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"
} | +| `trace` | [models.TraceConfig](../models/traceconfig) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | | `user` | *string* | :heavy_minus_sign: | A unique identifier representing your end-user, which helps distinguish between different users of your app. This allows your app to identify specific users in case of abuse reports, preventing your entire app from being affected by the actions of individual users. Maximum of 256 characters. | | \ No newline at end of file diff --git a/docs/models/messagessearchmodelsservertool.mdx b/docs/models/messagessearchmodelsservertool.mdx index aae62c6e1..668268e2a 100644 --- a/docs/models/messagessearchmodelsservertool.mdx +++ b/docs/models/messagessearchmodelsservertool.mdx @@ -18,5 +18,5 @@ let value: MessagesSearchModelsServerTool = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `parameters` | [models.SearchModelsServerToolConfig](../models/searchmodelsservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | -| `type` | [models.MessagesSearchModelsServerToolType](../models/messagessearchmodelsservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.SearchModelsServerToolConfig](../models/searchmodelsservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | +| `type` | [models.MessagesSearchModelsServerToolType](../models/messagessearchmodelsservertooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/messagestooladditionblock.mdx b/docs/models/messagestooladditionblock.mdx index cc21ce65c..862290b59 100644 --- a/docs/models/messagestooladditionblock.mdx +++ b/docs/models/messagestooladditionblock.mdx @@ -22,6 +22,6 @@ let value: MessagesToolAdditionBlock = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/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"
} | +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective) | :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` | *models.MessagesToolAdditionBlockToolUnion* | :heavy_check_mark: | N/A | | | `type` | *"tool_addition"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/messagestoolremovalblock.mdx b/docs/models/messagestoolremovalblock.mdx index 64e9bbc89..24c730f48 100644 --- a/docs/models/messagestoolremovalblock.mdx +++ b/docs/models/messagestoolremovalblock.mdx @@ -22,6 +22,6 @@ let value: MessagesToolRemovalBlock = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/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"
} | +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective) | :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` | *models.MessagesToolRemovalBlockToolUnion* | :heavy_check_mark: | N/A | | | `type` | *"tool_removal"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/model.mdx b/docs/models/model.mdx index 8f68225b5..40d1e2348 100644 --- a/docs/models/model.mdx +++ b/docs/models/model.mdx @@ -49,22 +49,22 @@ let value: Model = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `architecture` | [models.ModelArchitecture](../models/modelarchitecture.mdx) | :heavy_check_mark: | Model architecture information | \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
} | -| `benchmarks` | [models.ModelBenchmarks](../models/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
}
]
} | +| `architecture` | [models.ModelArchitecture](../models/modelarchitecture) | :heavy_check_mark: | Model architecture information | \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
} | +| `benchmarks` | [models.ModelBenchmarks](../models/modelbenchmarks) | :heavy_minus_sign: | Third-party benchmark rankings for this model. Omitted when no benchmark data is available. | \{
"artificial_analysis": \{
"agentic_index": 55.8,
"coding_index": 63.2,
"intelligence_index": 71.4
},
"design_arena": [
\{
"arena": "models",
"category": "website",
"elo": 1385.2,
"rank": 5,
"win_rate": 62.5
}
]
} | | `canonicalSlug` | *string* | :heavy_check_mark: | Canonical slug for the model | openai/gpt-4 | | `contextLength` | *number* | :heavy_check_mark: | Maximum context length in tokens | 8192 | | `created` | *number* | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | -| `defaultParameters` | [models.DefaultParameters](../models/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
} | +| `defaultParameters` | [models.DefaultParameters](../models/defaultparameters) | :heavy_check_mark: | Default parameters for this model | \{
"frequency_penalty": 0,
"presence_penalty": 0,
"repetition_penalty": 1,
"temperature": 0.7,
"top_k": 0,
"top_p": 0.9
} | | `description` | *string* | :heavy_minus_sign: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | | `expirationDate` | *string* | :heavy_minus_sign: | The date after which the model may be removed. ISO 8601 date string (YYYY-MM-DD) or null if no expiration. | 2025-06-01 | | `huggingFaceId` | *string* | :heavy_minus_sign: | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium | | `id` | *string* | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 | | `knowledgeCutoff` | *string* | :heavy_minus_sign: | The date up to which the model was trained on data. ISO 8601 date string (YYYY-MM-DD) or null if unknown. | 2024-10-01 | -| `links` | [models.ModelLinks](../models/modellinks.mdx) | :heavy_check_mark: | Related API endpoints and resources for this model. | \{
"details": "/api/v1/models/openai/gpt-5.4/endpoints"
} | +| `links` | [models.ModelLinks](../models/modellinks) | :heavy_check_mark: | Related API endpoints and resources for this model. | \{
"details": "/api/v1/models/openai/gpt-5.4/endpoints"
} | | `name` | *string* | :heavy_check_mark: | Display name of the model | GPT-4 | -| `perRequestLimits` | [models.PerRequestLimits](../models/perrequestlimits.mdx) | :heavy_check_mark: | Per-request token limits | \{
"completion_tokens": 1000,
"prompt_tokens": 1000
} | -| `pricing` | [models.PublicPricing](../models/publicpricing.mdx) | :heavy_check_mark: | Pricing information for the model | \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
} | -| `reasoning` | [models.ModelReasoning](../models/modelreasoning.mdx) | :heavy_minus_sign: | Reasoning effort configuration. Omitted for non-reasoning models and dynamic router models. | \{
"default_effort": "medium",
"default_enabled": true,
"mandatory": false,
"supported_efforts": [
"high",
"medium",
"low",
"minimal"
]
} | -| `supportedParameters` | [models.Parameter](../models/parameter.mdx)[] | :heavy_check_mark: | List of supported parameters for this model | | +| `perRequestLimits` | [models.PerRequestLimits](../models/perrequestlimits) | :heavy_check_mark: | Per-request token limits | \{
"completion_tokens": 1000,
"prompt_tokens": 1000
} | +| `pricing` | [models.PublicPricing](../models/publicpricing) | :heavy_check_mark: | Pricing information for the model | \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
} | +| `reasoning` | [models.ModelReasoning](../models/modelreasoning) | :heavy_minus_sign: | Reasoning effort configuration. Omitted for non-reasoning models and dynamic router models. | \{
"default_effort": "medium",
"default_enabled": true,
"mandatory": false,
"supported_efforts": [
"high",
"medium",
"low",
"minimal"
]
} | +| `supportedParameters` | [models.Parameter](../models/parameter)[] | :heavy_check_mark: | List of supported parameters for this model | | | `supportedVoices` | *string*[] | :heavy_check_mark: | List of supported voice identifiers for TTS models. Null for non-TTS models. | null | -| `topProvider` | [models.TopProviderInfo](../models/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 +| `topProvider` | [models.TopProviderInfo](../models/topproviderinfo) | :heavy_check_mark: | Information about the top provider for this model | \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
} | \ No newline at end of file diff --git a/docs/models/modelarchitecture.mdx b/docs/models/modelarchitecture.mdx index e7317099a..3f49f25db 100644 --- a/docs/models/modelarchitecture.mdx +++ b/docs/models/modelarchitecture.mdx @@ -24,8 +24,8 @@ let value: ModelArchitecture = { | Field | Type | Required | Description | Example | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `inputModalities` | [models.InputModality](../models/inputmodality.mdx)[] | :heavy_check_mark: | Supported input modalities | | -| `instructType` | [models.InstructType](../models/instructtype.mdx) | :heavy_minus_sign: | Instruction format type | chatml | +| `inputModalities` | [models.InputModality](../models/inputmodality)[] | :heavy_check_mark: | Supported input modalities | | +| `instructType` | [models.InstructType](../models/instructtype) | :heavy_minus_sign: | Instruction format type | chatml | | `modality` | *string* | :heavy_check_mark: | Primary modality of the model | text->text | -| `outputModalities` | [models.OutputModality](../models/outputmodality.mdx)[] | :heavy_check_mark: | Supported output modalities | | -| `tokenizer` | [models.ModelGroup](../models/modelgroup.mdx) | :heavy_minus_sign: | Tokenizer type used by the model | GPT | \ No newline at end of file +| `outputModalities` | [models.OutputModality](../models/outputmodality)[] | :heavy_check_mark: | Supported output modalities | | +| `tokenizer` | [models.ModelGroup](../models/modelgroup) | :heavy_minus_sign: | Tokenizer type used by the model | GPT | \ No newline at end of file diff --git a/docs/models/modelbenchmarks.mdx b/docs/models/modelbenchmarks.mdx index 89fbaf443..92d39a3a8 100644 --- a/docs/models/modelbenchmarks.mdx +++ b/docs/models/modelbenchmarks.mdx @@ -26,5 +26,5 @@ let value: ModelBenchmarks = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `artificialAnalysis` | [models.AABenchmarkEntry](../models/aabenchmarkentry.mdx) | :heavy_minus_sign: | Artificial Analysis benchmark index scores. | \{
"agentic_index": 55.8,
"coding_index": 63.2,
"intelligence_index": 71.4
} | -| `designArena` | [models.DABenchmarkEntry](../models/dabenchmarkentry.mdx)[] | :heavy_check_mark: | Design Arena ELO rankings across arena+category pairs. | [
\{
"arena": "models",
"category": "website",
"elo": 1385.2,
"rank": 5,
"win_rate": 62.5
}
] | \ No newline at end of file +| `artificialAnalysis` | [models.AABenchmarkEntry](../models/aabenchmarkentry) | :heavy_minus_sign: | Artificial Analysis benchmark index scores. | \{
"agentic_index": 55.8,
"coding_index": 63.2,
"intelligence_index": 71.4
} | +| `designArena` | [models.DABenchmarkEntry](../models/dabenchmarkentry)[] | :heavy_check_mark: | Design Arena ELO rankings across arena+category pairs. | [
\{
"arena": "models",
"category": "website",
"elo": 1385.2,
"rank": 5,
"win_rate": 62.5
}
] | \ No newline at end of file diff --git a/docs/models/modelreasoning.mdx b/docs/models/modelreasoning.mdx index 2cd23e651..934b64931 100644 --- a/docs/models/modelreasoning.mdx +++ b/docs/models/modelreasoning.mdx @@ -18,8 +18,8 @@ let value: ModelReasoning = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `defaultEffort` | [models.DefaultEffort](../models/defaulteffort.mdx) | :heavy_minus_sign: | N/A | medium | +| `defaultEffort` | [models.DefaultEffort](../models/defaulteffort) | :heavy_minus_sign: | N/A | medium | | `defaultEnabled` | *boolean* | :heavy_minus_sign: | Default reasoning enabled state when the client does not set `reasoning.enabled`. | | | `mandatory` | *boolean* | :heavy_check_mark: | When true, reasoning cannot be disabled and effort "none" is rejected. | | -| `supportedEfforts` | [models.ReasoningEffort](../models/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. | | +| `supportedEfforts` | [models.ReasoningEffort](../models/reasoningeffort)[] | :heavy_minus_sign: | Allowed reasoning effort values for this model, in descending effort order (highest first). Null means no allowlist — all gateway effort values are accepted. | | | `supportsMaxTokens` | *boolean* | :heavy_minus_sign: | Present and `true` when the model accepts `reasoning.max_tokens` in requests (Anthropic-style) instead of or in addition to `reasoning.effort`. Omitted otherwise. | | \ No newline at end of file diff --git a/docs/models/modelresponse.mdx b/docs/models/modelresponse.mdx index 0ee024a40..a2b6091bb 100644 --- a/docs/models/modelresponse.mdx +++ b/docs/models/modelresponse.mdx @@ -51,4 +51,4 @@ let value: ModelResponse = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.Model](../models/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` | [models.Model](../models/model) | :heavy_check_mark: | Information about an AI model available on OpenRouter | \{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-5.4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"reasoning": \{
"default_effort": "medium",
"default_enabled": true,
"mandatory": false,
"supported_efforts": [
"high",
"medium",
"low",
"minimal"
]
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
} | \ No newline at end of file diff --git a/docs/models/modelscountresponse.mdx b/docs/models/modelscountresponse.mdx index eb143205e..3634c869d 100644 --- a/docs/models/modelscountresponse.mdx +++ b/docs/models/modelscountresponse.mdx @@ -20,4 +20,4 @@ let value: ModelsCountResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `data` | [models.ModelsCountResponseData](../models/modelscountresponsedata.mdx) | :heavy_check_mark: | Model count data | \{
"count": 150
} | \ No newline at end of file +| `data` | [models.ModelsCountResponseData](../models/modelscountresponsedata) | :heavy_check_mark: | Model count data | \{
"count": 150
} | \ No newline at end of file diff --git a/docs/models/modelslistresponse.mdx b/docs/models/modelslistresponse.mdx index 7219f0f22..ed4c94af0 100644 --- a/docs/models/modelslistresponse.mdx +++ b/docs/models/modelslistresponse.mdx @@ -59,6 +59,6 @@ let value: ModelsListResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.Model](../models/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` | [models.Links](../models/links.mdx) | :heavy_check_mark: | Pagination links | | +| `data` | [models.Model](../models/model)[] | :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` | [models.Links](../models/links) | :heavy_check_mark: | Pagination links | | | `totalCount` | *number* | :heavy_check_mark: | Total number of models matching the query | 150 | \ No newline at end of file diff --git a/docs/models/namespacefunctiontool.mdx b/docs/models/namespacefunctiontool.mdx index 4a001f469..455f007f1 100644 --- a/docs/models/namespacefunctiontool.mdx +++ b/docs/models/namespacefunctiontool.mdx @@ -19,7 +19,7 @@ let value: NamespaceFunctionTool = { | Field | Type | Required | Description | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `allowedCallers` | [models.AllowedCaller](../models/allowedcaller.mdx)[] | :heavy_minus_sign: | N/A | +| `allowedCallers` | [models.AllowedCaller](../models/allowedcaller)[] | :heavy_minus_sign: | N/A | | `deferLoading` | *boolean* | :heavy_minus_sign: | N/A | | `description` | *string* | :heavy_minus_sign: | N/A | | `name` | *string* | :heavy_check_mark: | N/A | diff --git a/docs/models/namespacetool.mdx b/docs/models/namespacetool.mdx index 0e67a080b..72c11ed23 100644 --- a/docs/models/namespacetool.mdx +++ b/docs/models/namespacetool.mdx @@ -29,4 +29,4 @@ let value: NamespaceTool = { | `description` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_check_mark: | N/A | | `tools` | *models.NamespaceToolTool*[] | :heavy_check_mark: | N/A | -| `type` | [models.NamespaceToolType](../models/namespacetooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.NamespaceToolType](../models/namespacetooltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/observabilityarizedestination.mdx b/docs/models/observabilityarizedestination.mdx index 35c3bc045..2b10ca5ff 100644 --- a/docs/models/observabilityarizedestination.mdx +++ b/docs/models/observabilityarizedestination.mdx @@ -33,10 +33,10 @@ let value: ObservabilityArizeDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `config` | [models.ObservabilityArizeDestinationConfig](../models/observabilityarizedestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `config` | [models.ObservabilityArizeDestinationConfig](../models/observabilityarizedestinationconfig) | :heavy_check_mark: | N/A | | | `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | | `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | | `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | | `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | diff --git a/docs/models/observabilitybraintrustdestination.mdx b/docs/models/observabilitybraintrustdestination.mdx index 0e001abbf..3dcee10a7 100644 --- a/docs/models/observabilitybraintrustdestination.mdx +++ b/docs/models/observabilitybraintrustdestination.mdx @@ -32,10 +32,10 @@ let value: ObservabilityBraintrustDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `config` | [models.ObservabilityBraintrustDestinationConfig](../models/observabilitybraintrustdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `config` | [models.ObservabilityBraintrustDestinationConfig](../models/observabilitybraintrustdestinationconfig) | :heavy_check_mark: | N/A | | | `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | | `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | | `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | | `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | diff --git a/docs/models/observabilityclickhousedestination.mdx b/docs/models/observabilityclickhousedestination.mdx index 6cd991dcd..8d56d0c1e 100644 --- a/docs/models/observabilityclickhousedestination.mdx +++ b/docs/models/observabilityclickhousedestination.mdx @@ -33,10 +33,10 @@ let value: ObservabilityClickhouseDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `config` | [models.ObservabilityClickhouseDestinationConfig](../models/observabilityclickhousedestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `config` | [models.ObservabilityClickhouseDestinationConfig](../models/observabilityclickhousedestinationconfig) | :heavy_check_mark: | N/A | | | `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | | `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | | `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | | `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | diff --git a/docs/models/observabilitydatadogdestination.mdx b/docs/models/observabilitydatadogdestination.mdx index 38668cdfd..1b081b64e 100644 --- a/docs/models/observabilitydatadogdestination.mdx +++ b/docs/models/observabilitydatadogdestination.mdx @@ -31,10 +31,10 @@ let value: ObservabilityDatadogDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `config` | [models.ObservabilityDatadogDestinationConfig](../models/observabilitydatadogdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `config` | [models.ObservabilityDatadogDestinationConfig](../models/observabilitydatadogdestinationconfig) | :heavy_check_mark: | N/A | | | `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | | `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | | `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | | `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | diff --git a/docs/models/observabilityfilterrulegroup.mdx b/docs/models/observabilityfilterrulegroup.mdx index ceebfc7d8..35d669623 100644 --- a/docs/models/observabilityfilterrulegroup.mdx +++ b/docs/models/observabilityfilterrulegroup.mdx @@ -21,5 +21,5 @@ let value: ObservabilityFilterRuleGroup = { | Field | Type | Required | Description | | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | -| `logic` | [models.Logic](../models/logic.mdx) | :heavy_minus_sign: | N/A | -| `rules` | [models.Rule](../models/rule.mdx)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `logic` | [models.Logic](../models/logic) | :heavy_minus_sign: | N/A | +| `rules` | [models.Rule](../models/rule)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/observabilityfilterrulesconfig.mdx b/docs/models/observabilityfilterrulesconfig.mdx index ae315f7ed..571859e1b 100644 --- a/docs/models/observabilityfilterrulesconfig.mdx +++ b/docs/models/observabilityfilterrulesconfig.mdx @@ -28,4 +28,4 @@ let value: ObservabilityFilterRulesConfig = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | | `enabled` | *boolean* | :heavy_minus_sign: | N/A | -| `groups` | [models.ObservabilityFilterRuleGroup](../models/observabilityfilterrulegroup.mdx)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `groups` | [models.ObservabilityFilterRuleGroup](../models/observabilityfilterrulegroup)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/observabilityfilterrulesconfignullable.mdx b/docs/models/observabilityfilterrulesconfignullable.mdx index b88550be7..ed6de34d8 100644 --- a/docs/models/observabilityfilterrulesconfignullable.mdx +++ b/docs/models/observabilityfilterrulesconfignullable.mdx @@ -28,4 +28,4 @@ let value: ObservabilityFilterRulesConfigNullable = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | | `enabled` | *boolean* | :heavy_minus_sign: | N/A | -| `groups` | [models.ObservabilityFilterRuleGroup](../models/observabilityfilterrulegroup.mdx)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `groups` | [models.ObservabilityFilterRuleGroup](../models/observabilityfilterrulegroup)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/observabilitygrafanadestination.mdx b/docs/models/observabilitygrafanadestination.mdx index 4cbf7e266..f4ff1c91e 100644 --- a/docs/models/observabilitygrafanadestination.mdx +++ b/docs/models/observabilitygrafanadestination.mdx @@ -32,10 +32,10 @@ let value: ObservabilityGrafanaDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `config` | [models.ObservabilityGrafanaDestinationConfig](../models/observabilitygrafanadestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `config` | [models.ObservabilityGrafanaDestinationConfig](../models/observabilitygrafanadestinationconfig) | :heavy_check_mark: | N/A | | | `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | | `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | | `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | | `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | diff --git a/docs/models/observabilitylangfusedestination.mdx b/docs/models/observabilitylangfusedestination.mdx index 01b4beabd..7568a4d50 100644 --- a/docs/models/observabilitylangfusedestination.mdx +++ b/docs/models/observabilitylangfusedestination.mdx @@ -31,10 +31,10 @@ let value: ObservabilityLangfuseDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `config` | [models.ObservabilityLangfuseDestinationConfig](../models/observabilitylangfusedestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `config` | [models.ObservabilityLangfuseDestinationConfig](../models/observabilitylangfusedestinationconfig) | :heavy_check_mark: | N/A | | | `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | | `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | | `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | | `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | diff --git a/docs/models/observabilitylangsmithdestination.mdx b/docs/models/observabilitylangsmithdestination.mdx index b55cd910b..3b4627ea4 100644 --- a/docs/models/observabilitylangsmithdestination.mdx +++ b/docs/models/observabilitylangsmithdestination.mdx @@ -30,10 +30,10 @@ let value: ObservabilityLangsmithDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `config` | [models.ObservabilityLangsmithDestinationConfig](../models/observabilitylangsmithdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `config` | [models.ObservabilityLangsmithDestinationConfig](../models/observabilitylangsmithdestinationconfig) | :heavy_check_mark: | N/A | | | `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | | `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | | `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | | `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | diff --git a/docs/models/observabilitynewrelicdestination.mdx b/docs/models/observabilitynewrelicdestination.mdx index 9df00c342..722e62ac4 100644 --- a/docs/models/observabilitynewrelicdestination.mdx +++ b/docs/models/observabilitynewrelicdestination.mdx @@ -30,10 +30,10 @@ let value: ObservabilityNewrelicDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `config` | [models.ObservabilityNewrelicDestinationConfig](../models/observabilitynewrelicdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `config` | [models.ObservabilityNewrelicDestinationConfig](../models/observabilitynewrelicdestinationconfig) | :heavy_check_mark: | N/A | | | `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | | `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | | `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | | `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | diff --git a/docs/models/observabilitynewrelicdestinationconfig.mdx b/docs/models/observabilitynewrelicdestinationconfig.mdx index d588ede96..f7f61a888 100644 --- a/docs/models/observabilitynewrelicdestinationconfig.mdx +++ b/docs/models/observabilitynewrelicdestinationconfig.mdx @@ -18,4 +18,4 @@ let value: ObservabilityNewrelicDestinationConfig = { | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | | `headers` | Record\ | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | | `licenseKey` | *string* | :heavy_check_mark: | N/A | -| `region` | [models.Region](../models/region.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `region` | [models.Region](../models/region) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/observabilityopikdestination.mdx b/docs/models/observabilityopikdestination.mdx index 2e6fab865..b2d0804b0 100644 --- a/docs/models/observabilityopikdestination.mdx +++ b/docs/models/observabilityopikdestination.mdx @@ -32,10 +32,10 @@ let value: ObservabilityOpikDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `config` | [models.ObservabilityOpikDestinationConfig](../models/observabilityopikdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `config` | [models.ObservabilityOpikDestinationConfig](../models/observabilityopikdestinationconfig) | :heavy_check_mark: | N/A | | | `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | | `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | | `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | | `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | diff --git a/docs/models/observabilityotelcollectordestination.mdx b/docs/models/observabilityotelcollectordestination.mdx index e21d974e0..4c676066e 100644 --- a/docs/models/observabilityotelcollectordestination.mdx +++ b/docs/models/observabilityotelcollectordestination.mdx @@ -30,10 +30,10 @@ let value: ObservabilityOtelCollectorDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `config` | [models.ObservabilityOtelCollectorDestinationConfig](../models/observabilityotelcollectordestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `config` | [models.ObservabilityOtelCollectorDestinationConfig](../models/observabilityotelcollectordestinationconfig) | :heavy_check_mark: | N/A | | | `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | | `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | | `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | | `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | diff --git a/docs/models/observabilityposthogdestination.mdx b/docs/models/observabilityposthogdestination.mdx index a59b87224..f6e3ba8f6 100644 --- a/docs/models/observabilityposthogdestination.mdx +++ b/docs/models/observabilityposthogdestination.mdx @@ -30,10 +30,10 @@ let value: ObservabilityPosthogDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `config` | [models.ObservabilityPosthogDestinationConfig](../models/observabilityposthogdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `config` | [models.ObservabilityPosthogDestinationConfig](../models/observabilityposthogdestinationconfig) | :heavy_check_mark: | N/A | | | `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | | `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | | `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | | `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | diff --git a/docs/models/observabilityrampdestination.mdx b/docs/models/observabilityrampdestination.mdx index 888d3d544..565aef869 100644 --- a/docs/models/observabilityrampdestination.mdx +++ b/docs/models/observabilityrampdestination.mdx @@ -31,10 +31,10 @@ let value: ObservabilityRampDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `config` | [models.ObservabilityRampDestinationConfig](../models/observabilityrampdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `config` | [models.ObservabilityRampDestinationConfig](../models/observabilityrampdestinationconfig) | :heavy_check_mark: | N/A | | | `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | | `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | | `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | | `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | diff --git a/docs/models/observabilitys3destination.mdx b/docs/models/observabilitys3destination.mdx index dc9681c79..4055296cf 100644 --- a/docs/models/observabilitys3destination.mdx +++ b/docs/models/observabilitys3destination.mdx @@ -32,10 +32,10 @@ let value: ObservabilityS3Destination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `config` | [models.ObservabilityS3DestinationConfig](../models/observabilitys3destinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `config` | [models.ObservabilityS3DestinationConfig](../models/observabilitys3destinationconfig) | :heavy_check_mark: | N/A | | | `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | | `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | | `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | | `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | diff --git a/docs/models/observabilitysentrydestination.mdx b/docs/models/observabilitysentrydestination.mdx index 20dcb424e..b6b54b9a9 100644 --- a/docs/models/observabilitysentrydestination.mdx +++ b/docs/models/observabilitysentrydestination.mdx @@ -31,10 +31,10 @@ let value: ObservabilitySentryDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `config` | [models.ObservabilitySentryDestinationConfig](../models/observabilitysentrydestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `config` | [models.ObservabilitySentryDestinationConfig](../models/observabilitysentrydestinationconfig) | :heavy_check_mark: | N/A | | | `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | | `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | | `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | | `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | diff --git a/docs/models/observabilitysnowflakedestination.mdx b/docs/models/observabilitysnowflakedestination.mdx index 69ee93cec..3b3160935 100644 --- a/docs/models/observabilitysnowflakedestination.mdx +++ b/docs/models/observabilitysnowflakedestination.mdx @@ -31,10 +31,10 @@ let value: ObservabilitySnowflakeDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `config` | [models.ObservabilitySnowflakeDestinationConfig](../models/observabilitysnowflakedestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `config` | [models.ObservabilitySnowflakeDestinationConfig](../models/observabilitysnowflakedestinationconfig) | :heavy_check_mark: | N/A | | | `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | | `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | | `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | | `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | diff --git a/docs/models/observabilityweavedestination.mdx b/docs/models/observabilityweavedestination.mdx index a3dec0b55..15c06b8c6 100644 --- a/docs/models/observabilityweavedestination.mdx +++ b/docs/models/observabilityweavedestination.mdx @@ -33,10 +33,10 @@ let value: ObservabilityWeaveDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `config` | [models.ObservabilityWeaveDestinationConfig](../models/observabilityweavedestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `config` | [models.ObservabilityWeaveDestinationConfig](../models/observabilityweavedestinationconfig) | :heavy_check_mark: | N/A | | | `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | | `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | | `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | | `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | diff --git a/docs/models/observabilitywebhookdestination.mdx b/docs/models/observabilitywebhookdestination.mdx index ea3435f31..76ba1b39e 100644 --- a/docs/models/observabilitywebhookdestination.mdx +++ b/docs/models/observabilitywebhookdestination.mdx @@ -30,10 +30,10 @@ let value: ObservabilityWebhookDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `config` | [models.ObservabilityWebhookDestinationConfig](../models/observabilitywebhookdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `config` | [models.ObservabilityWebhookDestinationConfig](../models/observabilitywebhookdestinationconfig) | :heavy_check_mark: | N/A | | | `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | | `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | | `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | | `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | diff --git a/docs/models/observabilitywebhookdestinationconfig.mdx b/docs/models/observabilitywebhookdestinationconfig.mdx index 3ff0afc1e..a28e7fb02 100644 --- a/docs/models/observabilitywebhookdestinationconfig.mdx +++ b/docs/models/observabilitywebhookdestinationconfig.mdx @@ -17,5 +17,5 @@ let value: ObservabilityWebhookDestinationConfig = { | Field | Type | Required | Description | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | | `headers` | Record\ | :heavy_minus_sign: | N/A | -| `method` | [models.Method](../models/method.mdx) | :heavy_minus_sign: | N/A | +| `method` | [models.Method](../models/method) | :heavy_minus_sign: | N/A | | `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/openaifile.mdx b/docs/models/openaifile.mdx index df357b54f..fa1af4b99 100644 --- a/docs/models/openaifile.mdx +++ b/docs/models/openaifile.mdx @@ -25,11 +25,11 @@ let value: OpenAIFile = { | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `shape` | [models.OpenAIFileShape](../models/openaifileshape.mdx) | :heavy_check_mark: | N/A | +| `shape` | [models.OpenAIFileShape](../models/openaifileshape) | :heavy_check_mark: | N/A | | `bytes` | *number* | :heavy_check_mark: | N/A | | `createdAt` | *number* | :heavy_check_mark: | N/A | | `filename` | *string* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | -| `object` | [models.OpenAIFileObject](../models/openaifileobject.mdx) | :heavy_check_mark: | N/A | -| `purpose` | [models.Purpose](../models/purpose.mdx) | :heavy_check_mark: | N/A | -| `status` | [models.OpenAIFileStatus](../models/openaifilestatus.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `object` | [models.OpenAIFileObject](../models/openaifileobject) | :heavy_check_mark: | N/A | +| `purpose` | [models.Purpose](../models/purpose) | :heavy_check_mark: | N/A | +| `status` | [models.OpenAIFileStatus](../models/openaifilestatus) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/openaifiledeleted.mdx b/docs/models/openaifiledeleted.mdx index 41be61058..5818923b9 100644 --- a/docs/models/openaifiledeleted.mdx +++ b/docs/models/openaifiledeleted.mdx @@ -24,4 +24,4 @@ let value: OpenAIFileDeleted = { | `shape` | *"openai"* | :heavy_check_mark: | N/A | | `deleted` | *true* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | -| `object` | [models.OpenAIFileDeletedObject](../models/openaifiledeletedobject.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `object` | [models.OpenAIFileDeletedObject](../models/openaifiledeletedobject) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/openaifilelist.mdx b/docs/models/openaifilelist.mdx index 94cde56c4..a9371de7c 100644 --- a/docs/models/openaifilelist.mdx +++ b/docs/models/openaifilelist.mdx @@ -24,8 +24,8 @@ let value: OpenAIFileList = { | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | | `shape` | *"openai"* | :heavy_check_mark: | N/A | -| `data` | [models.OpenAIFile](../models/openaifile.mdx)[] | :heavy_check_mark: | N/A | +| `data` | [models.OpenAIFile](../models/openaifile)[] | :heavy_check_mark: | N/A | | `firstId` | *string* | :heavy_check_mark: | N/A | | `hasMore` | *boolean* | :heavy_check_mark: | N/A | | `lastId` | *string* | :heavy_check_mark: | N/A | -| `object` | [models.OpenAIFileListObject](../models/openaifilelistobject.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `object` | [models.OpenAIFileListObject](../models/openaifilelistobject) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/openairesponsecustomtoolcall.mdx b/docs/models/openairesponsecustomtoolcall.mdx index 5655e502f..665fcf22f 100644 --- a/docs/models/openairesponsecustomtoolcall.mdx +++ b/docs/models/openairesponsecustomtoolcall.mdx @@ -24,4 +24,4 @@ let value: OpenAIResponseCustomToolCall = { | `input` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_check_mark: | N/A | | `namespace` | *string* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | -| `type` | [models.OpenAIResponseCustomToolCallType](../models/openairesponsecustomtoolcalltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.OpenAIResponseCustomToolCallType](../models/openairesponsecustomtoolcalltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/openairesponsecustomtoolcalloutput.mdx b/docs/models/openairesponsecustomtoolcalloutput.mdx index cb6950272..6c7a6f71f 100644 --- a/docs/models/openairesponsecustomtoolcalloutput.mdx +++ b/docs/models/openairesponsecustomtoolcalloutput.mdx @@ -21,4 +21,4 @@ let value: OpenAIResponseCustomToolCallOutput = { | `callId` | *string* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_minus_sign: | N/A | | `output` | *models.OpenAIResponseCustomToolCallOutputOutput2* | :heavy_check_mark: | N/A | -| `type` | [models.OpenAIResponseCustomToolCallOutputType](../models/openairesponsecustomtoolcalloutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.OpenAIResponseCustomToolCallOutputType](../models/openairesponsecustomtoolcalloutputtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/openairesponsefunctiontoolcall.mdx b/docs/models/openairesponsefunctiontoolcall.mdx index 0db9fd36d..08449f685 100644 --- a/docs/models/openairesponsefunctiontoolcall.mdx +++ b/docs/models/openairesponsefunctiontoolcall.mdx @@ -24,5 +24,5 @@ let value: OpenAIResponseFunctionToolCall = { | `id` | *string* | :heavy_minus_sign: | N/A | | | `name` | *string* | :heavy_check_mark: | N/A | | | `namespace` | *string* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | -| `type` | [models.OpenAIResponseFunctionToolCallType](../models/openairesponsefunctiontoolcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `status` | [models.ToolCallStatus](../models/toolcallstatus) | :heavy_minus_sign: | N/A | completed | +| `type` | [models.OpenAIResponseFunctionToolCallType](../models/openairesponsefunctiontoolcalltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/openairesponsefunctiontoolcalloutput.mdx b/docs/models/openairesponsefunctiontoolcalloutput.mdx index 190ddbcff..9df508eca 100644 --- a/docs/models/openairesponsefunctiontoolcalloutput.mdx +++ b/docs/models/openairesponsefunctiontoolcalloutput.mdx @@ -21,5 +21,5 @@ let value: OpenAIResponseFunctionToolCallOutput = { | `callId` | *string* | :heavy_check_mark: | N/A | | | `id` | *string* | :heavy_minus_sign: | N/A | | | `output` | *models.OpenAIResponseFunctionToolCallOutputOutput2* | :heavy_check_mark: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | -| `type` | [models.OpenAIResponseFunctionToolCallOutputType](../models/openairesponsefunctiontoolcalloutputtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `status` | [models.ToolCallStatus](../models/toolcallstatus) | :heavy_minus_sign: | N/A | completed | +| `type` | [models.OpenAIResponseFunctionToolCallOutputType](../models/openairesponsefunctiontoolcalloutputtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/openairesponseinputmessageitem.mdx b/docs/models/openairesponseinputmessageitem.mdx index 9cab2c14a..b028ec654 100644 --- a/docs/models/openairesponseinputmessageitem.mdx +++ b/docs/models/openairesponseinputmessageitem.mdx @@ -26,4 +26,4 @@ let value: OpenAIResponseInputMessageItem = { | `content` | *models.OpenAIResponseInputMessageItemContent*[] | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | | `role` | *models.OpenAIResponseInputMessageItemRoleUnion* | :heavy_check_mark: | N/A | -| `type` | [models.OpenAIResponseInputMessageItemType](../models/openairesponseinputmessageitemtype.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | [models.OpenAIResponseInputMessageItemType](../models/openairesponseinputmessageitemtype) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/openairesponsestoolchoiceapplypatch.mdx b/docs/models/openairesponsestoolchoiceapplypatch.mdx index c0fb820df..61944c9eb 100644 --- a/docs/models/openairesponsestoolchoiceapplypatch.mdx +++ b/docs/models/openairesponsestoolchoiceapplypatch.mdx @@ -16,4 +16,4 @@ let value: OpenAIResponsesToolChoiceApplyPatch = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `type` | [models.OpenAIResponsesToolChoiceTypeApplyPatch](../models/openairesponsestoolchoicetypeapplypatch.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.OpenAIResponsesToolChoiceTypeApplyPatch](../models/openairesponsestoolchoicetypeapplypatch) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/openairesponsestoolchoicefunction.mdx b/docs/models/openairesponsestoolchoicefunction.mdx index de1714e19..64cf860ad 100644 --- a/docs/models/openairesponsestoolchoicefunction.mdx +++ b/docs/models/openairesponsestoolchoicefunction.mdx @@ -18,4 +18,4 @@ let value: OpenAIResponsesToolChoiceFunction = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | | `name` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.OpenAIResponsesToolChoiceTypeFunction](../models/openairesponsestoolchoicetypefunction.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.OpenAIResponsesToolChoiceTypeFunction](../models/openairesponsestoolchoicetypefunction) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/openairesponsestoolchoiceshell.mdx b/docs/models/openairesponsestoolchoiceshell.mdx index 9adcdeccb..80ff3f778 100644 --- a/docs/models/openairesponsestoolchoiceshell.mdx +++ b/docs/models/openairesponsestoolchoiceshell.mdx @@ -16,4 +16,4 @@ let value: OpenAIResponsesToolChoiceShell = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `type` | [models.OpenAIResponsesToolChoiceTypeShell](../models/openairesponsestoolchoicetypeshell.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.OpenAIResponsesToolChoiceTypeShell](../models/openairesponsestoolchoicetypeshell) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/openresponsescreatedevent.mdx b/docs/models/openresponsescreatedevent.mdx index 481686da2..88555ce8b 100644 --- a/docs/models/openresponsescreatedevent.mdx +++ b/docs/models/openresponsescreatedevent.mdx @@ -39,6 +39,6 @@ let value: OpenResponsesCreatedEvent = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [models.OpenResponsesResult](../models/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
}
} | +| `response` | [models.OpenResponsesResult](../models/openresponsesresult) | :heavy_check_mark: | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | | `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | | `type` | *"response.created"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/openresponsesinprogressevent.mdx b/docs/models/openresponsesinprogressevent.mdx index c10478623..a33853634 100644 --- a/docs/models/openresponsesinprogressevent.mdx +++ b/docs/models/openresponsesinprogressevent.mdx @@ -39,6 +39,6 @@ let value: OpenResponsesInProgressEvent = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [models.OpenResponsesResult](../models/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
}
} | +| `response` | [models.OpenResponsesResult](../models/openresponsesresult) | :heavy_check_mark: | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | | `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | | `type` | *"response.in_progress"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/openresponsesresult.mdx b/docs/models/openresponsesresult.mdx index 7d978a022..6dde25c91 100644 --- a/docs/models/openresponsesresult.mdx +++ b/docs/models/openresponsesresult.mdx @@ -50,37 +50,37 @@ let value: OpenResponsesResult = { | `background` | *boolean* | :heavy_minus_sign: | N/A | | | `completedAt` | *number* | :heavy_check_mark: | N/A | | | `createdAt` | *number* | :heavy_check_mark: | N/A | | -| `error` | [models.ResponsesErrorField](../models/responseserrorfield.mdx) | :heavy_check_mark: | Error information returned from the API | \{
"code": "rate_limit_exceeded",
"message": "Rate limit exceeded. Please try again later."
} | +| `error` | [models.ResponsesErrorField](../models/responseserrorfield) | :heavy_check_mark: | Error information returned from the API | \{
"code": "rate_limit_exceeded",
"message": "Rate limit exceeded. Please try again later."
} | | `frequencyPenalty` | *number* | :heavy_check_mark: | N/A | | | `id` | *string* | :heavy_check_mark: | N/A | | -| `incompleteDetails` | [models.IncompleteDetails](../models/incompletedetails.mdx) | :heavy_check_mark: | N/A | \{
"reason": "max_output_tokens"
} | +| `incompleteDetails` | [models.IncompleteDetails](../models/incompletedetails) | :heavy_check_mark: | N/A | \{
"reason": "max_output_tokens"
} | | `instructions` | *models.BaseInputsUnion* | :heavy_check_mark: | N/A | [
\{
"content": "What is the weather today?",
"role": "user"
}
] | | `maxOutputTokens` | *number* | :heavy_minus_sign: | N/A | | | `maxToolCalls` | *number* | :heavy_minus_sign: | N/A | | | `metadata` | Record\ | :heavy_check_mark: | Metadata key-value pairs for the request. Keys must be ≤64 characters and cannot contain brackets. Values must be ≤512 characters. Maximum 16 pairs allowed. | \{
"session_id": "abc-def-ghi",
"user_id": "123"
} | | `model` | *string* | :heavy_check_mark: | N/A | | -| `object` | [models.OpenResponsesResultObject](../models/openresponsesresultobject.mdx) | :heavy_check_mark: | N/A | | +| `object` | [models.OpenResponsesResultObject](../models/openresponsesresultobject) | :heavy_check_mark: | N/A | | | `output` | *models.OutputItems*[] | :heavy_check_mark: | N/A | | | `outputText` | *string* | :heavy_minus_sign: | N/A | | | `parallelToolCalls` | *boolean* | :heavy_check_mark: | N/A | | | `presencePenalty` | *number* | :heavy_check_mark: | N/A | | | `previousResponseId` | *string* | :heavy_minus_sign: | N/A | | -| `prompt` | [models.StoredPromptTemplate](../models/storedprompttemplate.mdx) | :heavy_minus_sign: | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | +| `prompt` | [models.StoredPromptTemplate](../models/storedprompttemplate) | :heavy_minus_sign: | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | | `promptCacheKey` | *string* | :heavy_minus_sign: | N/A | | -| `promptCacheOptions` | [models.PromptCacheOptions](../models/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` | [models.BaseReasoningConfig](../models/basereasoningconfig.mdx) | :heavy_minus_sign: | N/A | \{
"effort": "medium",
"summary": "auto"
} | +| `promptCacheOptions` | [models.PromptCacheOptions](../models/promptcacheoptions) | :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` | [models.BaseReasoningConfig](../models/basereasoningconfig) | :heavy_minus_sign: | N/A | \{
"effort": "medium",
"summary": "auto"
} | | `safetyIdentifier` | *string* | :heavy_minus_sign: | N/A | | | `serviceTier` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.OpenAIResponsesResponseStatus](../models/openairesponsesresponsestatus.mdx) | :heavy_check_mark: | N/A | completed | +| `status` | [models.OpenAIResponsesResponseStatus](../models/openairesponsesresponsestatus) | :heavy_check_mark: | N/A | completed | | `store` | *boolean* | :heavy_minus_sign: | N/A | | | `temperature` | *number* | :heavy_check_mark: | N/A | | -| `text` | [models.TextExtendedConfig](../models/textextendedconfig.mdx) | :heavy_minus_sign: | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | +| `text` | [models.TextExtendedConfig](../models/textextendedconfig) | :heavy_minus_sign: | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | | `toolChoice` | *models.OpenAIResponsesToolChoiceUnion* | :heavy_check_mark: | N/A | auto | | `tools` | *models.OpenResponsesResultToolUnion*[] | :heavy_check_mark: | N/A | | | `topLogprobs` | *number* | :heavy_minus_sign: | N/A | | | `topP` | *number* | :heavy_check_mark: | N/A | | -| `truncation` | [models.Truncation](../models/truncation.mdx) | :heavy_minus_sign: | N/A | auto | -| `usage` | [models.Usage](../models/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
} | +| `truncation` | [models.Truncation](../models/truncation) | :heavy_minus_sign: | N/A | auto | +| `usage` | [models.Usage](../models/usage) | :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` | *string* | :heavy_minus_sign: | N/A | | -| `errorType` | [models.ApiErrorType](../models/apierrortype.mdx) | :heavy_minus_sign: | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | -| `openrouterMetadata` | [models.OpenRouterMetadata](../models/openroutermetadata.mdx) | :heavy_minus_sign: | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | \ No newline at end of file +| `errorType` | [models.ApiErrorType](../models/apierrortype) | :heavy_minus_sign: | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | +| `openrouterMetadata` | [models.OpenRouterMetadata](../models/openroutermetadata) | :heavy_minus_sign: | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | \ No newline at end of file diff --git a/docs/models/openrouterfile.mdx b/docs/models/openrouterfile.mdx index 812404832..e910489c7 100644 --- a/docs/models/openrouterfile.mdx +++ b/docs/models/openrouterfile.mdx @@ -25,11 +25,11 @@ let value: OpenRouterFile = { | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `shape` | [models.OpenRouterFileShape](../models/openrouterfileshape.mdx) | :heavy_check_mark: | N/A | +| `shape` | [models.OpenRouterFileShape](../models/openrouterfileshape) | :heavy_check_mark: | N/A | | `createdAt` | *string* | :heavy_check_mark: | N/A | | `downloadable` | *boolean* | :heavy_check_mark: | N/A | | `filename` | *string* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | | `mimeType` | *string* | :heavy_check_mark: | N/A | | `sizeBytes` | *number* | :heavy_check_mark: | N/A | -| `type` | [models.OpenRouterFileType](../models/openrouterfiletype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.OpenRouterFileType](../models/openrouterfiletype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/openrouterfiledeleted.mdx b/docs/models/openrouterfiledeleted.mdx index f181dd5bf..4c1273a54 100644 --- a/docs/models/openrouterfiledeleted.mdx +++ b/docs/models/openrouterfiledeleted.mdx @@ -22,4 +22,4 @@ let value: OpenRouterFileDeleted = { | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | | `shape` | *"openrouter"* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.OpenRouterFileDeletedType](../models/openrouterfiledeletedtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.OpenRouterFileDeletedType](../models/openrouterfiledeletedtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/openrouterfilelist.mdx b/docs/models/openrouterfilelist.mdx index b313f25d2..70ace5172 100644 --- a/docs/models/openrouterfilelist.mdx +++ b/docs/models/openrouterfilelist.mdx @@ -25,7 +25,7 @@ let value: OpenRouterFileList = { | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | | `shape` | *"openrouter"* | :heavy_check_mark: | N/A | | `cursor` | *string* | :heavy_check_mark: | Opaque cursor for the next page; null when there are no more results. | -| `data` | [models.OpenRouterFile](../models/openrouterfile.mdx)[] | :heavy_check_mark: | N/A | +| `data` | [models.OpenRouterFile](../models/openrouterfile)[] | :heavy_check_mark: | N/A | | `firstId` | *string* | :heavy_check_mark: | N/A | | `hasMore` | *boolean* | :heavy_check_mark: | N/A | | `lastId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/openroutermetadata.mdx b/docs/models/openroutermetadata.mdx index 567f52fd0..1cd452da7 100644 --- a/docs/models/openroutermetadata.mdx +++ b/docs/models/openroutermetadata.mdx @@ -32,12 +32,12 @@ let value: OpenRouterMetadata = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | | `attempt` | *number* | :heavy_check_mark: | N/A | | -| `attempts` | [models.RouterAttempt](../models/routerattempt.mdx)[] | :heavy_minus_sign: | N/A | | -| `endpoints` | [models.EndpointsMetadata](../models/endpointsmetadata.mdx) | :heavy_check_mark: | N/A | \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 3
} | +| `attempts` | [models.RouterAttempt](../models/routerattempt)[] | :heavy_minus_sign: | N/A | | +| `endpoints` | [models.EndpointsMetadata](../models/endpointsmetadata) | :heavy_check_mark: | N/A | \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 3
} | | `isByok` | *boolean* | :heavy_check_mark: | N/A | | -| `params` | [models.RouterParams](../models/routerparams.mdx) | :heavy_minus_sign: | N/A | \{
"version_group": "anthropic/claude-sonnet-4"
} | -| `pipeline` | [models.PipelineStage](../models/pipelinestage.mdx)[] | :heavy_minus_sign: | N/A | | +| `params` | [models.RouterParams](../models/routerparams) | :heavy_minus_sign: | N/A | \{
"version_group": "anthropic/claude-sonnet-4"
} | +| `pipeline` | [models.PipelineStage](../models/pipelinestage)[] | :heavy_minus_sign: | N/A | | | `region` | *string* | :heavy_check_mark: | N/A | | | `requested` | *string* | :heavy_check_mark: | N/A | | -| `strategy` | [models.RoutingStrategy](../models/routingstrategy.mdx) | :heavy_check_mark: | N/A | direct | +| `strategy` | [models.RoutingStrategy](../models/routingstrategy) | :heavy_check_mark: | N/A | direct | | `summary` | *string* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/openrouterwebsearchservertool.mdx b/docs/models/openrouterwebsearchservertool.mdx index 61b3a32cc..cf209c4cf 100644 --- a/docs/models/openrouterwebsearchservertool.mdx +++ b/docs/models/openrouterwebsearchservertool.mdx @@ -18,5 +18,5 @@ let value: OpenRouterWebSearchServerTool = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `parameters` | [models.WebSearchConfig](../models/websearchconfig.mdx) | :heavy_minus_sign: | N/A | \{
"max_results": 5,
"search_context_size": "medium"
} | -| `type` | [models.OpenRouterWebSearchServerToolType](../models/openrouterwebsearchservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.WebSearchConfig](../models/websearchconfig) | :heavy_minus_sign: | N/A | \{
"max_results": 5,
"search_context_size": "medium"
} | +| `type` | [models.OpenRouterWebSearchServerToolType](../models/openrouterwebsearchservertooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/bulkaddworkspacemembersrequest.mdx b/docs/models/operations/bulkaddworkspacemembersrequest.mdx index af0ad1e5d..7679ab4c2 100644 --- a/docs/models/operations/bulkaddworkspacemembersrequest.mdx +++ b/docs/models/operations/bulkaddworkspacemembersrequest.mdx @@ -26,4 +26,4 @@ let value: BulkAddWorkspaceMembersRequest = { | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | | `id` | *string* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `bulkAddWorkspaceMembersRequest` | [models.BulkAddWorkspaceMembersRequest](../../models/bulkaddworkspacemembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file +| `bulkAddWorkspaceMembersRequest` | [models.BulkAddWorkspaceMembersRequest](../../models/bulkaddworkspacemembersrequest) | :heavy_check_mark: | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file diff --git a/docs/models/operations/bulkassignkeystoguardrailrequest.mdx b/docs/models/operations/bulkassignkeystoguardrailrequest.mdx index 08f990e31..9b258fbc2 100644 --- a/docs/models/operations/bulkassignkeystoguardrailrequest.mdx +++ b/docs/models/operations/bulkassignkeystoguardrailrequest.mdx @@ -25,4 +25,4 @@ let value: BulkAssignKeysToGuardrailRequest = { | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | | `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulkAssignKeysRequest` | [models.BulkAssignKeysRequest](../../models/bulkassignkeysrequest.mdx) | :heavy_check_mark: | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | \ No newline at end of file +| `bulkAssignKeysRequest` | [models.BulkAssignKeysRequest](../../models/bulkassignkeysrequest) | :heavy_check_mark: | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | \ No newline at end of file diff --git a/docs/models/operations/bulkassignmemberstoguardrailrequest.mdx b/docs/models/operations/bulkassignmemberstoguardrailrequest.mdx index 9d61077f9..ef5444dd6 100644 --- a/docs/models/operations/bulkassignmemberstoguardrailrequest.mdx +++ b/docs/models/operations/bulkassignmemberstoguardrailrequest.mdx @@ -26,4 +26,4 @@ let value: BulkAssignMembersToGuardrailRequest = { | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | | `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulkAssignMembersRequest` | [models.BulkAssignMembersRequest](../../models/bulkassignmembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file +| `bulkAssignMembersRequest` | [models.BulkAssignMembersRequest](../../models/bulkassignmembersrequest) | :heavy_check_mark: | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file diff --git a/docs/models/operations/bulkremoveworkspacemembersrequest.mdx b/docs/models/operations/bulkremoveworkspacemembersrequest.mdx index 8e7fb4fca..60dfe479f 100644 --- a/docs/models/operations/bulkremoveworkspacemembersrequest.mdx +++ b/docs/models/operations/bulkremoveworkspacemembersrequest.mdx @@ -26,4 +26,4 @@ let value: BulkRemoveWorkspaceMembersRequest = { | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | | `id` | *string* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `bulkRemoveWorkspaceMembersRequest` | [models.BulkRemoveWorkspaceMembersRequest](../../models/bulkremoveworkspacemembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file +| `bulkRemoveWorkspaceMembersRequest` | [models.BulkRemoveWorkspaceMembersRequest](../../models/bulkremoveworkspacemembersrequest) | :heavy_check_mark: | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file diff --git a/docs/models/operations/bulkunassignkeysfromguardrailrequest.mdx b/docs/models/operations/bulkunassignkeysfromguardrailrequest.mdx index 65af5d906..73317ca19 100644 --- a/docs/models/operations/bulkunassignkeysfromguardrailrequest.mdx +++ b/docs/models/operations/bulkunassignkeysfromguardrailrequest.mdx @@ -25,4 +25,4 @@ let value: BulkUnassignKeysFromGuardrailRequest = { | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | | `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulkUnassignKeysRequest` | [models.BulkUnassignKeysRequest](../../models/bulkunassignkeysrequest.mdx) | :heavy_check_mark: | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | \ No newline at end of file +| `bulkUnassignKeysRequest` | [models.BulkUnassignKeysRequest](../../models/bulkunassignkeysrequest) | :heavy_check_mark: | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | \ No newline at end of file diff --git a/docs/models/operations/bulkunassignmembersfromguardrailrequest.mdx b/docs/models/operations/bulkunassignmembersfromguardrailrequest.mdx index 17cfc9eac..ca0b130b2 100644 --- a/docs/models/operations/bulkunassignmembersfromguardrailrequest.mdx +++ b/docs/models/operations/bulkunassignmembersfromguardrailrequest.mdx @@ -26,4 +26,4 @@ let value: BulkUnassignMembersFromGuardrailRequest = { | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | | `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulkUnassignMembersRequest` | [models.BulkUnassignMembersRequest](../../models/bulkunassignmembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file +| `bulkUnassignMembersRequest` | [models.BulkUnassignMembersRequest](../../models/bulkunassignmembersrequest) | :heavy_check_mark: | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file diff --git a/docs/models/operations/classifierfilters.mdx b/docs/models/operations/classifierfilters.mdx index cb983c222..658696f6c 100644 --- a/docs/models/operations/classifierfilters.mdx +++ b/docs/models/operations/classifierfilters.mdx @@ -20,4 +20,4 @@ let value: ClassifierFilters = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | | `classifierId` | *string* | :heavy_check_mark: | UUID of the classifier whose tags to filter by. Must match classifier_dimensions.classifier_id when both are specified. | 550e8400-e29b-41d4-a716-446655440000 | -| `filters` | [operations.ClassifierFiltersFilter](../../models/operations/classifierfiltersfilter.mdx)[] | :heavy_check_mark: | N/A | | \ No newline at end of file +| `filters` | [operations.ClassifierFiltersFilter](../../models/operations/classifierfiltersfilter)[] | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/contentimageurl.mdx b/docs/models/operations/contentimageurl.mdx index d5d371885..489f2fcc6 100644 --- a/docs/models/operations/contentimageurl.mdx +++ b/docs/models/operations/contentimageurl.mdx @@ -19,5 +19,5 @@ let value: ContentImageURL = { | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `imageUrl` | [operations.ImageUrl](../../models/operations/imageurl.mdx) | :heavy_check_mark: | N/A | +| `imageUrl` | [operations.ImageUrl](../../models/operations/imageurl) | :heavy_check_mark: | N/A | | `type` | *"image_url"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/createaudiospeechrequest.mdx b/docs/models/operations/createaudiospeechrequest.mdx index f765a84ef..273a0dc48 100644 --- a/docs/models/operations/createaudiospeechrequest.mdx +++ b/docs/models/operations/createaudiospeechrequest.mdx @@ -23,4 +23,4 @@ let value: CreateAudioSpeechRequest = { | `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `speechRequest` | [models.SpeechRequest](../../models/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 +| `speechRequest` | [models.SpeechRequest](../../models/speechrequest) | :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/models/operations/createaudiotranscriptionsmultipartrequest.mdx b/docs/models/operations/createaudiotranscriptionsmultipartrequest.mdx index e08cabe88..09dc9a36a 100644 --- a/docs/models/operations/createaudiotranscriptionsmultipartrequest.mdx +++ b/docs/models/operations/createaudiotranscriptionsmultipartrequest.mdx @@ -17,4 +17,4 @@ import { CreateAudioTranscriptionsMultipartRequest } from "@openrouter/sdk/model | `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `requestBody` | [operations.CreateAudioTranscriptionsMultipartRequestBody](../../models/operations/createaudiotranscriptionsmultipartrequestbody.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `requestBody` | [operations.CreateAudioTranscriptionsMultipartRequestBody](../../models/operations/createaudiotranscriptionsmultipartrequestbody) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/createaudiotranscriptionsmultipartrequestbody.mdx b/docs/models/operations/createaudiotranscriptionsmultipartrequestbody.mdx index bfcbac846..1fdc06b59 100644 --- a/docs/models/operations/createaudiotranscriptionsmultipartrequestbody.mdx +++ b/docs/models/operations/createaudiotranscriptionsmultipartrequestbody.mdx @@ -14,9 +14,9 @@ import { CreateAudioTranscriptionsMultipartRequestBody } from "@openrouter/sdk/m | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `file` | [File](https://developer.mozilla.org/en-US/docs/Web/API/File) \| [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) \| [operations.CreateAudioTranscriptionsMultipartFile](../../models/operations/createaudiotranscriptionsmultipartfile.mdx) | :heavy_check_mark: | 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. | +| `file` | [File](https://developer.mozilla.org/en-US/docs/Web/API/File) \| [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) \| [operations.CreateAudioTranscriptionsMultipartFile](../../models/operations/createaudiotranscriptionsmultipartfile) | :heavy_check_mark: | 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. | | `language` | *string* | :heavy_minus_sign: | The language of the input audio (ISO-639-1). | | `model` | *string* | :heavy_check_mark: | The model to use for transcription. | -| `responseFormat` | [operations.ResponseFormat](../../models/operations/responseformat.mdx) | :heavy_minus_sign: | The response format. "json" (default) returns \{ text, usage }; "verbose_json" additionally returns task, language, duration, and segment-level timestamps (OpenAI-compatible providers only). | +| `responseFormat` | [operations.ResponseFormat](../../models/operations/responseformat) | :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). | | `temperature` | *number* | :heavy_minus_sign: | The sampling temperature. | -| `timestampGranularities` | [operations.TimestampGranularities](../../models/operations/timestampgranularities.mdx)[] | :heavy_minus_sign: | Timestamp detail levels to include when response_format is "verbose_json". "word" additionally returns word-level timestamps in the words array. | \ No newline at end of file +| `timestampGranularities` | [operations.TimestampGranularities](../../models/operations/timestampgranularities)[] | :heavy_minus_sign: | Timestamp detail levels to include when response_format is "verbose_json". "word" additionally returns word-level timestamps in the words array. | \ No newline at end of file diff --git a/docs/models/operations/createaudiotranscriptionsrequest.mdx b/docs/models/operations/createaudiotranscriptionsrequest.mdx index 5c888d9ba..bb3ab2afb 100644 --- a/docs/models/operations/createaudiotranscriptionsrequest.mdx +++ b/docs/models/operations/createaudiotranscriptionsrequest.mdx @@ -25,4 +25,4 @@ let value: CreateAudioTranscriptionsRequest = { | `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `sttRequest` | [models.STTRequest](../../models/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 +| `sttRequest` | [models.STTRequest](../../models/sttrequest) | :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/models/operations/createauthkeyscoderequest.mdx b/docs/models/operations/createauthkeyscoderequest.mdx index 39755411d..ada9658d9 100644 --- a/docs/models/operations/createauthkeyscoderequest.mdx +++ b/docs/models/operations/createauthkeyscoderequest.mdx @@ -21,4 +21,4 @@ let value: CreateAuthKeysCodeRequest = { | `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `requestBody` | [operations.CreateAuthKeysCodeRequestBody](../../models/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 +| `requestBody` | [operations.CreateAuthKeysCodeRequestBody](../../models/operations/createauthkeyscoderequestbody) | :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/models/operations/createauthkeyscoderequestbody.mdx b/docs/models/operations/createauthkeyscoderequestbody.mdx index dab3b2b1c..8d97ab2ec 100644 --- a/docs/models/operations/createauthkeyscoderequestbody.mdx +++ b/docs/models/operations/createauthkeyscoderequestbody.mdx @@ -18,9 +18,9 @@ let value: CreateAuthKeysCodeRequestBody = { | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | | `callbackUrl` | *string* | :heavy_check_mark: | The callback URL to redirect to after authorization. Supports https URLs and localhost/127.0.0.1 URLs on any port for local CLI tools. | https://myapp.com/auth/callback | | `codeChallenge` | *string* | :heavy_minus_sign: | PKCE code challenge for enhanced security | E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM | -| `codeChallengeMethod` | [operations.CreateAuthKeysCodeCodeChallengeMethod](../../models/operations/createauthkeyscodecodechallengemethod.mdx) | :heavy_minus_sign: | The method used to generate the code challenge | S256 | +| `codeChallengeMethod` | [operations.CreateAuthKeysCodeCodeChallengeMethod](../../models/operations/createauthkeyscodecodechallengemethod) | :heavy_minus_sign: | The method used to generate the code challenge | S256 | | `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | Optional expiration time for the API key to be created | 2027-12-31T23:59:59Z | | `keyLabel` | *string* | :heavy_minus_sign: | Optional custom label for the API key. Defaults to the app name if not provided. | My Custom Key | | `limit` | *number* | :heavy_minus_sign: | Credit limit for the API key to be created | 100 | -| `usageLimitType` | [operations.UsageLimitType](../../models/operations/usagelimittype.mdx) | :heavy_minus_sign: | Optional credit limit reset interval. When set, the credit limit resets on this interval. | monthly | +| `usageLimitType` | [operations.UsageLimitType](../../models/operations/usagelimittype) | :heavy_minus_sign: | Optional credit limit reset interval. When set, the credit limit resets on this interval. | monthly | | `workspaceId` | *string* | :heavy_minus_sign: | Optional workspace ID to associate the API key with | | \ No newline at end of file diff --git a/docs/models/operations/createauthkeyscoderesponse.mdx b/docs/models/operations/createauthkeyscoderesponse.mdx index 789491e61..a6dd563f2 100644 --- a/docs/models/operations/createauthkeyscoderesponse.mdx +++ b/docs/models/operations/createauthkeyscoderesponse.mdx @@ -22,4 +22,4 @@ let value: CreateAuthKeysCodeResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `data` | [operations.CreateAuthKeysCodeData](../../models/operations/createauthkeyscodedata.mdx) | :heavy_check_mark: | Auth code data | \{
"app_id": 12345,
"created_at": "2025-08-24T10:30:00Z",
"id": "auth_code_xyz789"
} | \ No newline at end of file +| `data` | [operations.CreateAuthKeysCodeData](../../models/operations/createauthkeyscodedata) | :heavy_check_mark: | Auth code data | \{
"app_id": 12345,
"created_at": "2025-08-24T10:30:00Z",
"id": "auth_code_xyz789"
} | \ No newline at end of file diff --git a/docs/models/operations/createbyokkeyrequest.mdx b/docs/models/operations/createbyokkeyrequest.mdx index 2416ec001..5d95783a4 100644 --- a/docs/models/operations/createbyokkeyrequest.mdx +++ b/docs/models/operations/createbyokkeyrequest.mdx @@ -22,4 +22,4 @@ let value: CreateBYOKKeyRequest = { | `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `createBYOKKeyRequest` | [models.CreateBYOKKeyRequest](../../models/createbyokkeyrequest.mdx) | :heavy_check_mark: | N/A | \{
"key": "sk-proj-abc123...",
"name": "Production OpenAI Key",
"provider": "openai"
} | \ No newline at end of file +| `createBYOKKeyRequest` | [models.CreateBYOKKeyRequest](../../models/createbyokkeyrequest) | :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/models/operations/createembeddingsdata.mdx b/docs/models/operations/createembeddingsdata.mdx index bbbb459ab..d32e9eb0c 100644 --- a/docs/models/operations/createembeddingsdata.mdx +++ b/docs/models/operations/createembeddingsdata.mdx @@ -25,4 +25,4 @@ let value: CreateEmbeddingsData = { | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | | `embedding` | *operations.Embedding* | :heavy_check_mark: | Embedding vector as an array of floats or a base64 string | [
0.0023064255,
-0.009327292,
0.015797347
] | | `index` | *number* | :heavy_minus_sign: | Index of the embedding in the input list | 0 | -| `object` | [operations.ObjectEmbedding](../../models/operations/objectembedding.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `object` | [operations.ObjectEmbedding](../../models/operations/objectembedding) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/createembeddingsrequest.mdx b/docs/models/operations/createembeddingsrequest.mdx index 57829559d..4add5f588 100644 --- a/docs/models/operations/createembeddingsrequest.mdx +++ b/docs/models/operations/createembeddingsrequest.mdx @@ -22,4 +22,4 @@ let value: CreateEmbeddingsRequest = { | `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `requestBody` | [operations.CreateEmbeddingsRequestBody](../../models/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 +| `requestBody` | [operations.CreateEmbeddingsRequestBody](../../models/operations/createembeddingsrequestbody) | :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/models/operations/createembeddingsrequestbody.mdx b/docs/models/operations/createembeddingsrequestbody.mdx index a1f0c15f2..1117d6797 100644 --- a/docs/models/operations/createembeddingsrequestbody.mdx +++ b/docs/models/operations/createembeddingsrequestbody.mdx @@ -20,9 +20,9 @@ let value: CreateEmbeddingsRequestBody = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | | `dimensions` | *number* | :heavy_minus_sign: | The number of dimensions for the output embeddings | 1536 | -| `encodingFormat` | [operations.EncodingFormat](../../models/operations/encodingformat.mdx) | :heavy_minus_sign: | The format of the output embeddings | float | +| `encodingFormat` | [operations.EncodingFormat](../../models/operations/encodingformat) | :heavy_minus_sign: | The format of the output embeddings | float | | `input` | *operations.InputUnion* | :heavy_check_mark: | Text, token, or multimodal input(s) to embed | The quick brown fox jumps over the lazy dog | | `inputType` | *string* | :heavy_minus_sign: | The type of input (e.g. search_query, search_document) | search_query | | `model` | *string* | :heavy_check_mark: | The model to use for embeddings | openai/text-embedding-3-small | -| `provider` | [models.ProviderPreferences](../../models/providerpreferences.mdx) | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | +| `provider` | [models.ProviderPreferences](../../models/providerpreferences) | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | | `user` | *string* | :heavy_minus_sign: | A unique identifier for the end-user | user-1234 | \ No newline at end of file diff --git a/docs/models/operations/createembeddingsresponsebody.mdx b/docs/models/operations/createembeddingsresponsebody.mdx index 594734d20..b3f77dc68 100644 --- a/docs/models/operations/createembeddingsresponsebody.mdx +++ b/docs/models/operations/createembeddingsresponsebody.mdx @@ -29,8 +29,8 @@ let value: CreateEmbeddingsResponseBody = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `data` | [operations.CreateEmbeddingsData](../../models/operations/createembeddingsdata.mdx)[] | :heavy_check_mark: | List of embedding objects | [
\{
"embedding": [
0.0023064255,
-0.009327292,
0.015797347
],
"index": 0,
"object": "embedding"
}
] | +| `data` | [operations.CreateEmbeddingsData](../../models/operations/createembeddingsdata)[] | :heavy_check_mark: | List of embedding objects | [
\{
"embedding": [
0.0023064255,
-0.009327292,
0.015797347
],
"index": 0,
"object": "embedding"
}
] | | `id` | *string* | :heavy_minus_sign: | Unique identifier for the embeddings response | embd-1234567890 | | `model` | *string* | :heavy_check_mark: | The model used for embeddings | openai/text-embedding-3-small | -| `object` | [operations.ObjectT](../../models/operations/objectt.mdx) | :heavy_check_mark: | N/A | | -| `usage` | [operations.CreateEmbeddingsUsage](../../models/operations/createembeddingsusage.mdx) | :heavy_minus_sign: | Token usage statistics | \{
"prompt_tokens": 8,
"total_tokens": 8
} | \ No newline at end of file +| `object` | [operations.ObjectT](../../models/operations/objectt) | :heavy_check_mark: | N/A | | +| `usage` | [operations.CreateEmbeddingsUsage](../../models/operations/createembeddingsusage) | :heavy_minus_sign: | Token usage statistics | \{
"prompt_tokens": 8,
"total_tokens": 8
} | \ No newline at end of file diff --git a/docs/models/operations/createembeddingsusage.mdx b/docs/models/operations/createembeddingsusage.mdx index 518b2109c..a1c2d98dd 100644 --- a/docs/models/operations/createembeddingsusage.mdx +++ b/docs/models/operations/createembeddingsusage.mdx @@ -20,8 +20,8 @@ let value: CreateEmbeddingsUsage = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `cost` | *number* | :heavy_minus_sign: | Cost of the request in credits | 0.0001 | -| `costDetails` | [models.CostDetails](../../models/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
} | +| `costDetails` | [models.CostDetails](../../models/costdetails) | :heavy_minus_sign: | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | | `isByok` | *boolean* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | | `promptTokens` | *number* | :heavy_check_mark: | Number of tokens in the input | 8 | -| `promptTokensDetails` | [operations.PromptTokensDetails](../../models/operations/prompttokensdetails.mdx) | :heavy_minus_sign: | Per-modality token breakdown. Only present when the input contains 2+ modalities (e.g. text + image) and the upstream provider returns modality-level usage data. Only non-zero modality counts are included. | | +| `promptTokensDetails` | [operations.PromptTokensDetails](../../models/operations/prompttokensdetails) | :heavy_minus_sign: | Per-modality token breakdown. Only present when the input contains 2+ modalities (e.g. text + image) and the upstream provider returns modality-level usage data. Only non-zero modality counts are included. | | | `totalTokens` | *number* | :heavy_check_mark: | Total number of tokens used | 8 | \ No newline at end of file diff --git a/docs/models/operations/createguardrailrequest.mdx b/docs/models/operations/createguardrailrequest.mdx index a06bc9a53..1c5adae22 100644 --- a/docs/models/operations/createguardrailrequest.mdx +++ b/docs/models/operations/createguardrailrequest.mdx @@ -21,4 +21,4 @@ let value: CreateGuardrailRequest = { | `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `createGuardrailRequest` | [models.CreateGuardrailRequest](../../models/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 +| `createGuardrailRequest` | [models.CreateGuardrailRequest](../../models/createguardrailrequest) | :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/models/operations/createimagesrequest.mdx b/docs/models/operations/createimagesrequest.mdx index a793792ee..b41872e07 100644 --- a/docs/models/operations/createimagesrequest.mdx +++ b/docs/models/operations/createimagesrequest.mdx @@ -22,4 +22,4 @@ let value: CreateImagesRequest = { | `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `imageGenerationRequest` | [models.ImageGenerationRequest](../../models/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 +| `imageGenerationRequest` | [models.ImageGenerationRequest](../../models/imagegenerationrequest) | :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/models/operations/createkeysrequest.mdx b/docs/models/operations/createkeysrequest.mdx index 45a9a6b95..8302aa653 100644 --- a/docs/models/operations/createkeysrequest.mdx +++ b/docs/models/operations/createkeysrequest.mdx @@ -21,4 +21,4 @@ let value: CreateKeysRequest = { | `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `requestBody` | [operations.CreateKeysRequestBody](../../models/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 +| `requestBody` | [operations.CreateKeysRequestBody](../../models/operations/createkeysrequestbody) | :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/models/operations/createkeysrequestbody.mdx b/docs/models/operations/createkeysrequestbody.mdx index 9189f92e9..6a32e7c4d 100644 --- a/docs/models/operations/createkeysrequestbody.mdx +++ b/docs/models/operations/createkeysrequestbody.mdx @@ -20,6 +20,6 @@ let value: CreateKeysRequestBody = { | `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | Optional ISO 8601 UTC timestamp when the API key should expire. Must be UTC, other timezones will be rejected | 2027-12-31T23:59:59Z | | `includeByokInLimit` | *boolean* | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | | `limit` | *number* | :heavy_minus_sign: | Optional spending limit for the API key in USD | 50 | -| `limitReset` | [operations.CreateKeysLimitReset](../../models/operations/createkeyslimitreset.mdx) | :heavy_minus_sign: | Type of limit reset for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday. | monthly | +| `limitReset` | [operations.CreateKeysLimitReset](../../models/operations/createkeyslimitreset) | :heavy_minus_sign: | Type of limit reset for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday. | monthly | | `name` | *string* | :heavy_check_mark: | Name for the new API key | My New API Key | | `workspaceId` | *string* | :heavy_minus_sign: | The workspace to create the API key in. Defaults to the default workspace if not provided. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/operations/createkeysresponse.mdx b/docs/models/operations/createkeysresponse.mdx index 985ac04dd..d6b7b1964 100644 --- a/docs/models/operations/createkeysresponse.mdx +++ b/docs/models/operations/createkeysresponse.mdx @@ -41,5 +41,5 @@ let value: CreateKeysResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [operations.CreateKeysData](../../models/operations/createkeysdata.mdx) | :heavy_check_mark: | The created API key information | \{
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"created_at": "2025-08-24T10:30:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"disabled": false,
"expires_at": "2027-12-31T23:59:59Z",
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"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"
} | +| `data` | [operations.CreateKeysData](../../models/operations/createkeysdata) | :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",
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"name": "My Production Key",
"updated_at": "2025-08-24T15:45:00Z",
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5,
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | | `key` | *string* | :heavy_check_mark: | The actual API key string (only shown once) | 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 | \ No newline at end of file diff --git a/docs/models/operations/createobservabilitydestinationrequest.mdx b/docs/models/operations/createobservabilitydestinationrequest.mdx index c3a6cae27..768479a76 100644 --- a/docs/models/operations/createobservabilitydestinationrequest.mdx +++ b/docs/models/operations/createobservabilitydestinationrequest.mdx @@ -27,4 +27,4 @@ let value: CreateObservabilityDestinationRequest = { | `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `createObservabilityDestinationRequest` | [models.CreateObservabilityDestinationRequest](../../models/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 +| `createObservabilityDestinationRequest` | [models.CreateObservabilityDestinationRequest](../../models/createobservabilitydestinationrequest) | :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/models/operations/createpresetschatcompletionsrequest.mdx b/docs/models/operations/createpresetschatcompletionsrequest.mdx index 5e096021f..526e04606 100644 --- a/docs/models/operations/createpresetschatcompletionsrequest.mdx +++ b/docs/models/operations/createpresetschatcompletionsrequest.mdx @@ -32,4 +32,4 @@ let value: CreatePresetsChatCompletionsRequest = { | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | | `slug` | *string* | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `chatRequest` | [models.ChatRequest](../../models/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 +| `chatRequest` | [models.ChatRequest](../../models/chatrequest) | :heavy_check_mark: | N/A | \{
"max_tokens": 150,
"messages": [
\{
"content": "You are a helpful assistant.",
"role": "system"
},
\{
"content": "What is the capital of France?",
"role": "user"
}
],
"model": "openai/gpt-4",
"temperature": 0.7
} | \ No newline at end of file diff --git a/docs/models/operations/createpresetsmessagesrequest.mdx b/docs/models/operations/createpresetsmessagesrequest.mdx index 99659fcd2..6f60ee629 100644 --- a/docs/models/operations/createpresetsmessagesrequest.mdx +++ b/docs/models/operations/createpresetsmessagesrequest.mdx @@ -29,4 +29,4 @@ let value: CreatePresetsMessagesRequest = { | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | | `slug` | *string* | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `messagesRequest` | [models.MessagesRequest](../../models/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 +| `messagesRequest` | [models.MessagesRequest](../../models/messagesrequest) | :heavy_check_mark: | N/A | \{
"max_tokens": 1024,
"messages": [
\{
"content": "Hello, how are you?",
"role": "user"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7
} | \ No newline at end of file diff --git a/docs/models/operations/createpresetsresponsesrequest.mdx b/docs/models/operations/createpresetsresponsesrequest.mdx index 30f45321b..77134cc0f 100644 --- a/docs/models/operations/createpresetsresponsesrequest.mdx +++ b/docs/models/operations/createpresetsresponsesrequest.mdx @@ -21,4 +21,4 @@ let value: CreatePresetsResponsesRequest = { | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | | `slug` | *string* | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `responsesRequest` | [models.ResponsesRequest](../../models/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 +| `responsesRequest` | [models.ResponsesRequest](../../models/responsesrequest) | :heavy_check_mark: | N/A | \{
"input": [
\{
"content": "Hello, how are you?",
"role": "user",
"type": "message"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7,
"tools": [
\{
"description": "Get the current weather in a given location",
"name": "get_current_weather",
"parameters": \{
"properties": \{
"location": \{
"type": "string"
}
},
"type": "object"
},
"type": "function"
}
],
"top_p": 0.9
} | \ No newline at end of file diff --git a/docs/models/operations/creatererankrequest.mdx b/docs/models/operations/creatererankrequest.mdx index 56a83c1ad..3d28ffa6f 100644 --- a/docs/models/operations/creatererankrequest.mdx +++ b/docs/models/operations/creatererankrequest.mdx @@ -26,4 +26,4 @@ let value: CreateRerankRequest = { | `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `requestBody` | [operations.CreateRerankRequestBody](../../models/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 +| `requestBody` | [operations.CreateRerankRequestBody](../../models/operations/creatererankrequestbody) | :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/models/operations/creatererankrequestbody.mdx b/docs/models/operations/creatererankrequestbody.mdx index b0d4ae440..ddfbb752f 100644 --- a/docs/models/operations/creatererankrequestbody.mdx +++ b/docs/models/operations/creatererankrequestbody.mdx @@ -25,6 +25,6 @@ let value: CreateRerankRequestBody = { | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `documents` | *operations.Document*[] | :heavy_check_mark: | The list of documents to rerank. Documents may be plain strings, or structured objects with `text` and/or `image` for multimodal models. | [
"Paris is the capital of France.",
"Berlin is the capital of Germany."
] | | `model` | *string* | :heavy_check_mark: | The rerank model to use | cohere/rerank-v3.5 | -| `provider` | [models.ProviderPreferences](../../models/providerpreferences.mdx) | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | +| `provider` | [models.ProviderPreferences](../../models/providerpreferences) | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | | `query` | *string* | :heavy_check_mark: | The search query to rerank documents against | What is the capital of France? | | `topN` | *number* | :heavy_minus_sign: | Number of most relevant documents to return | 3 | \ No newline at end of file diff --git a/docs/models/operations/creatererankresponsebody.mdx b/docs/models/operations/creatererankresponsebody.mdx index c5cf33dc5..382460a65 100644 --- a/docs/models/operations/creatererankresponsebody.mdx +++ b/docs/models/operations/creatererankresponsebody.mdx @@ -28,5 +28,5 @@ let value: CreateRerankResponseBody = { | `id` | *string* | :heavy_minus_sign: | Unique identifier for the rerank response (ORID format) | gen-rerank-1234567890-abc | | `model` | *string* | :heavy_check_mark: | The model used for reranking | cohere/rerank-v3.5 | | `provider` | *string* | :heavy_minus_sign: | The provider that served the rerank request | Cohere | -| `results` | [operations.Result](../../models/operations/result.mdx)[] | :heavy_check_mark: | List of rerank results sorted by relevance | [
\{
"document": \{
"text": "Paris is the capital of France."
},
"index": 0,
"relevance_score": 0.98
}
] | -| `usage` | [operations.CreateRerankUsage](../../models/operations/creatererankusage.mdx) | :heavy_minus_sign: | Usage statistics | \{
"search_units": 1,
"total_tokens": 150
} | \ No newline at end of file +| `results` | [operations.Result](../../models/operations/result)[] | :heavy_check_mark: | List of rerank results sorted by relevance | [
\{
"document": \{
"text": "Paris is the capital of France."
},
"index": 0,
"relevance_score": 0.98
}
] | +| `usage` | [operations.CreateRerankUsage](../../models/operations/creatererankusage) | :heavy_minus_sign: | Usage statistics | \{
"search_units": 1,
"total_tokens": 150
} | \ No newline at end of file diff --git a/docs/models/operations/createresponsesrequest.mdx b/docs/models/operations/createresponsesrequest.mdx index 2f957e8df..ec61d5390 100644 --- a/docs/models/operations/createresponsesrequest.mdx +++ b/docs/models/operations/createresponsesrequest.mdx @@ -19,5 +19,5 @@ let value: CreateResponsesRequest = { | `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `xOpenRouterMetadata` | [models.MetadataLevel](../../models/metadatalevel.mdx) | :heavy_minus_sign: | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility. | enabled | -| `responsesRequest` | [models.ResponsesRequest](../../models/responsesrequest.mdx) | :heavy_check_mark: | N/A | \{
"input": [
\{
"content": "Hello, how are you?",
"role": "user",
"type": "message"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7,
"tools": [
\{
"description": "Get the current weather in a given location",
"name": "get_current_weather",
"parameters": \{
"properties": \{
"location": \{
"type": "string"
}
},
"type": "object"
},
"type": "function"
}
],
"top_p": 0.9
} | \ No newline at end of file +| `xOpenRouterMetadata` | [models.MetadataLevel](../../models/metadatalevel) | :heavy_minus_sign: | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility. | enabled | +| `responsesRequest` | [models.ResponsesRequest](../../models/responsesrequest) | :heavy_check_mark: | N/A | \{
"input": [
\{
"content": "Hello, how are you?",
"role": "user",
"type": "message"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7,
"tools": [
\{
"description": "Get the current weather in a given location",
"name": "get_current_weather",
"parameters": \{
"properties": \{
"location": \{
"type": "string"
}
},
"type": "object"
},
"type": "function"
}
],
"top_p": 0.9
} | \ No newline at end of file diff --git a/docs/models/operations/createvideosrequest.mdx b/docs/models/operations/createvideosrequest.mdx index 46f719cf0..76e10834e 100644 --- a/docs/models/operations/createvideosrequest.mdx +++ b/docs/models/operations/createvideosrequest.mdx @@ -21,4 +21,4 @@ let value: CreateVideosRequest = { | `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `videoGenerationRequest` | [models.VideoGenerationRequest](../../models/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 +| `videoGenerationRequest` | [models.VideoGenerationRequest](../../models/videogenerationrequest) | :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/models/operations/createworkspacerequest.mdx b/docs/models/operations/createworkspacerequest.mdx index 05a8ce2d9..7e64e19db 100644 --- a/docs/models/operations/createworkspacerequest.mdx +++ b/docs/models/operations/createworkspacerequest.mdx @@ -22,4 +22,4 @@ let value: CreateWorkspaceRequest = { | `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `createWorkspaceRequest` | [models.CreateWorkspaceRequest](../../models/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 +| `createWorkspaceRequest` | [models.CreateWorkspaceRequest](../../models/createworkspacerequest) | :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/models/operations/deletefilerequest.mdx b/docs/models/operations/deletefilerequest.mdx index f84c73e33..b1477f49a 100644 --- a/docs/models/operations/deletefilerequest.mdx +++ b/docs/models/operations/deletefilerequest.mdx @@ -21,4 +21,4 @@ let value: DeleteFileRequest = { | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | | `fileId` | *string* | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | | `workspaceId` | *string* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [models.FileProvider](../../models/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 +| `provider` | [models.FileProvider](../../models/fileprovider) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | \ No newline at end of file diff --git a/docs/models/operations/deleteworkspacebudgetrequest.mdx b/docs/models/operations/deleteworkspacebudgetrequest.mdx index 242b8c841..54a5c8b33 100644 --- a/docs/models/operations/deleteworkspacebudgetrequest.mdx +++ b/docs/models/operations/deleteworkspacebudgetrequest.mdx @@ -21,4 +21,4 @@ let value: DeleteWorkspaceBudgetRequest = { | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | | `id` | *string* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `interval` | [models.WorkspaceBudgetInterval](../../models/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 +| `interval` | [models.WorkspaceBudgetInterval](../../models/workspacebudgetinterval) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | \ No newline at end of file diff --git a/docs/models/operations/downloadfilecontentrequest.mdx b/docs/models/operations/downloadfilecontentrequest.mdx index 2d1ff0a87..6dfa79b3c 100644 --- a/docs/models/operations/downloadfilecontentrequest.mdx +++ b/docs/models/operations/downloadfilecontentrequest.mdx @@ -21,4 +21,4 @@ let value: DownloadFileContentRequest = { | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | | `fileId` | *string* | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | | `workspaceId` | *string* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [models.FileProvider](../../models/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 +| `provider` | [models.FileProvider](../../models/fileprovider) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | \ No newline at end of file diff --git a/docs/models/operations/exchangeauthcodeforapikeyrequest.mdx b/docs/models/operations/exchangeauthcodeforapikeyrequest.mdx index 773deda36..5af2910d3 100644 --- a/docs/models/operations/exchangeauthcodeforapikeyrequest.mdx +++ b/docs/models/operations/exchangeauthcodeforapikeyrequest.mdx @@ -21,4 +21,4 @@ let value: ExchangeAuthCodeForAPIKeyRequest = { | `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `requestBody` | [operations.ExchangeAuthCodeForAPIKeyRequestBody](../../models/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 +| `requestBody` | [operations.ExchangeAuthCodeForAPIKeyRequestBody](../../models/operations/exchangeauthcodeforapikeyrequestbody) | :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/models/operations/exchangeauthcodeforapikeyrequestbody.mdx b/docs/models/operations/exchangeauthcodeforapikeyrequestbody.mdx index 761049a02..053fb2a48 100644 --- a/docs/models/operations/exchangeauthcodeforapikeyrequestbody.mdx +++ b/docs/models/operations/exchangeauthcodeforapikeyrequestbody.mdx @@ -17,5 +17,5 @@ let value: ExchangeAuthCodeForAPIKeyRequestBody = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `code` | *string* | :heavy_check_mark: | The authorization code received from the OAuth redirect | auth_code_abc123def456 | -| `codeChallengeMethod` | [operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethod](../../models/operations/exchangeauthcodeforapikeycodechallengemethod.mdx) | :heavy_minus_sign: | The method used to generate the code challenge | S256 | +| `codeChallengeMethod` | [operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethod](../../models/operations/exchangeauthcodeforapikeycodechallengemethod) | :heavy_minus_sign: | The method used to generate the code challenge | S256 | | `codeVerifier` | *string* | :heavy_minus_sign: | The code verifier if code_challenge was used in the authorization request | dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk | \ No newline at end of file diff --git a/docs/models/operations/getanalyticsmetadata.mdx b/docs/models/operations/getanalyticsmetadata.mdx index f3e248455..02967dc61 100644 --- a/docs/models/operations/getanalyticsmetadata.mdx +++ b/docs/models/operations/getanalyticsmetadata.mdx @@ -31,7 +31,7 @@ let value: GetAnalyticsMetaData = { | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `dimensions` | [operations.Dimension](../../models/operations/dimension.mdx)[] | :heavy_check_mark: | N/A | -| `granularities` | [operations.Granularity](../../models/operations/granularity.mdx)[] | :heavy_check_mark: | N/A | -| `metrics` | [operations.Metric](../../models/operations/metric.mdx)[] | :heavy_check_mark: | N/A | -| `operators` | [operations.Operator](../../models/operations/operator.mdx)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `dimensions` | [operations.Dimension](../../models/operations/dimension)[] | :heavy_check_mark: | N/A | +| `granularities` | [operations.Granularity](../../models/operations/granularity)[] | :heavy_check_mark: | N/A | +| `metrics` | [operations.Metric](../../models/operations/metric)[] | :heavy_check_mark: | N/A | +| `operators` | [operations.Operator](../../models/operations/operator)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getanalyticsmetaresponse.mdx b/docs/models/operations/getanalyticsmetaresponse.mdx index 300a5308e..288fb353d 100644 --- a/docs/models/operations/getanalyticsmetaresponse.mdx +++ b/docs/models/operations/getanalyticsmetaresponse.mdx @@ -40,4 +40,4 @@ let value: GetAnalyticsMetaResponse = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `data` | [operations.GetAnalyticsMetaData](../../models/operations/getanalyticsmetadata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [operations.GetAnalyticsMetaData](../../models/operations/getanalyticsmetadata) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getapprankingsrequest.mdx b/docs/models/operations/getapprankingsrequest.mdx index d17fc2d87..d1c6dc559 100644 --- a/docs/models/operations/getapprankingsrequest.mdx +++ b/docs/models/operations/getapprankingsrequest.mdx @@ -17,9 +17,9 @@ let value: GetAppRankingsRequest = {}; | `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `category` | [operations.GetAppRankingsCategory](../../models/operations/getapprankingscategory.mdx) | :heavy_minus_sign: | Marketplace category group to filter by (e.g. `coding`). Only apps tagged with a subcategory inside this group are returned. Mutually combinable with `subcategory` — when both are supplied the `subcategory` must belong to the `category` group. | coding | -| `subcategory` | [operations.Subcategory](../../models/operations/subcategory.mdx) | :heavy_minus_sign: | Marketplace subcategory to filter by (e.g. `cli-agent`). Takes precedence over `category` for the actual filter; when `category` is also supplied the pair must be consistent. | cli-agent | -| `sort` | [operations.GetAppRankingsSort](../../models/operations/getapprankingssort.mdx) | :heavy_minus_sign: | `popular` ranks apps by total token volume inside the date window. `trending` ranks apps by absolute excess token growth: window volume minus the average volume of the three equal-length periods immediately preceding the window. Apps with no excess growth are omitted from `trending` results. | popular | +| `category` | [operations.GetAppRankingsCategory](../../models/operations/getapprankingscategory) | :heavy_minus_sign: | Marketplace category group to filter by (e.g. `coding`). Only apps tagged with a subcategory inside this group are returned. Mutually combinable with `subcategory` — when both are supplied the `subcategory` must belong to the `category` group. | coding | +| `subcategory` | [operations.Subcategory](../../models/operations/subcategory) | :heavy_minus_sign: | Marketplace subcategory to filter by (e.g. `cli-agent`). Takes precedence over `category` for the actual filter; when `category` is also supplied the pair must be consistent. | cli-agent | +| `sort` | [operations.GetAppRankingsSort](../../models/operations/getapprankingssort) | :heavy_minus_sign: | `popular` ranks apps by total token volume inside the date window. `trending` ranks apps by absolute excess token growth: window volume minus the average volume of the three equal-length periods immediately preceding the window. Apps with no excess growth are omitted from `trending` results. | popular | | `startDate` | *string* | :heavy_minus_sign: | Start of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to 30 days before `end_date`. The dataset begins at 2025-01-01; earlier values are clamped forward to that floor and the resolved value is echoed in `meta.start_date`. | 2026-04-12 | | `endDate` | *string* | :heavy_minus_sign: | End of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to the most recent completed UTC day. Must be on or after 2025-01-01; earlier values are rejected with a 400. | 2026-05-11 | | `limit` | *number* | :heavy_minus_sign: | Maximum number of apps to return (1-100). Defaults to 50. | 50 | diff --git a/docs/models/operations/getapprankingsresponse.mdx b/docs/models/operations/getapprankingsresponse.mdx index e3c9ad6e1..c226e2bd7 100644 --- a/docs/models/operations/getapprankingsresponse.mdx +++ b/docs/models/operations/getapprankingsresponse.mdx @@ -39,4 +39,4 @@ let value: GetAppRankingsResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `result` | [models.AppRankingsResponse](../../models/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:00Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
}
} | \ No newline at end of file +| `result` | [models.AppRankingsResponse](../../models/apprankingsresponse) | :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:00Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
}
} | \ No newline at end of file diff --git a/docs/models/operations/getbenchmarksrequest.mdx b/docs/models/operations/getbenchmarksrequest.mdx index 7d7b23fb1..dca963728 100644 --- a/docs/models/operations/getbenchmarksrequest.mdx +++ b/docs/models/operations/getbenchmarksrequest.mdx @@ -17,8 +17,8 @@ let value: GetBenchmarksRequest = {}; | `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `source` | [operations.Source](../../models/operations/source.mdx) | :heavy_minus_sign: | Benchmark source to query. Determines the shape of the returned items. When omitted, returns results from all sources. | artificial-analysis | -| `taskType` | [operations.TaskType](../../models/operations/tasktype.mdx) | :heavy_minus_sign: | Filter results by task type. For Artificial Analysis, maps to the corresponding index. For Design Arena, maps to the matching category. | coding | -| `arena` | [operations.Arena](../../models/operations/arena.mdx) | :heavy_minus_sign: | Design Arena only: arena to query. Defaults to `models` when source is `design-arena`. | models | +| `source` | [operations.Source](../../models/operations/source) | :heavy_minus_sign: | Benchmark source to query. Determines the shape of the returned items. When omitted, returns results from all sources. | artificial-analysis | +| `taskType` | [operations.TaskType](../../models/operations/tasktype) | :heavy_minus_sign: | Filter results by task type. For Artificial Analysis, maps to the corresponding index. For Design Arena, maps to the matching category. | coding | +| `arena` | [operations.Arena](../../models/operations/arena) | :heavy_minus_sign: | Design Arena only: arena to query. Defaults to `models` when source is `design-arena`. | models | | `category` | *string* | :heavy_minus_sign: | Design Arena only: category within the arena (e.g. `codecategories`, `uicomponent`, `gamedev`, `3d`, `dataviz`, `image`, `video`, `svg`). When omitted, returns all categories. | codecategories | | `maxResults` | *number* | :heavy_minus_sign: | Maximum number of items to return. When omitted, all matching results are returned. | 50 | \ No newline at end of file diff --git a/docs/models/operations/getcreditsresponse.mdx b/docs/models/operations/getcreditsresponse.mdx index 1b5382b91..98aecebc3 100644 --- a/docs/models/operations/getcreditsresponse.mdx +++ b/docs/models/operations/getcreditsresponse.mdx @@ -21,4 +21,4 @@ let value: GetCreditsResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `data` | [operations.GetCreditsData](../../models/operations/getcreditsdata.mdx) | :heavy_check_mark: | N/A | \{
"total_credits": 100.5,
"total_usage": 25.75
} | \ No newline at end of file +| `data` | [operations.GetCreditsData](../../models/operations/getcreditsdata) | :heavy_check_mark: | N/A | \{
"total_credits": 100.5,
"total_usage": 25.75
} | \ No newline at end of file diff --git a/docs/models/operations/getcurrentkeydata.mdx b/docs/models/operations/getcurrentkeydata.mdx index c36327c67..05bb29f3a 100644 --- a/docs/models/operations/getcurrentkeydata.mdx +++ b/docs/models/operations/getcurrentkeydata.mdx @@ -53,7 +53,7 @@ let value: GetCurrentKeyData = { | `limit` | *number* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | | `limitRemaining` | *number* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | | `limitReset` | *string* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| ~~`rateLimit`~~ | [operations.RateLimit](../../models/operations/ratelimit.mdx) | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Legacy rate limit information about a key. Will always return -1. | \{
"interval": "1h",
"note": "This field is deprecated and safe to ignore.",
"requests": 1000
} | +| ~~`rateLimit`~~ | [operations.RateLimit](../../models/operations/ratelimit) | :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` | *number* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | | `usageDaily` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | | `usageMonthly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | diff --git a/docs/models/operations/getcurrentkeyresponse.mdx b/docs/models/operations/getcurrentkeyresponse.mdx index 6a2188134..5d6a9e119 100644 --- a/docs/models/operations/getcurrentkeyresponse.mdx +++ b/docs/models/operations/getcurrentkeyresponse.mdx @@ -41,4 +41,4 @@ let value: GetCurrentKeyResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [operations.GetCurrentKeyData](../../models/operations/getcurrentkeydata.mdx) | :heavy_check_mark: | Current API key information | \{
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"expires_at": "2027-12-31T23:59:59Z",
"include_byok_in_limit": false,
"is_free_tier": false,
"is_management_key": false,
"is_provisioning_key": false,
"label": "sk-or-v1-au7...890",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"rate_limit": \{
"interval": "1h",
"note": "This field is deprecated and safe to ignore.",
"requests": 1000
},
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5
} | \ No newline at end of file +| `data` | [operations.GetCurrentKeyData](../../models/operations/getcurrentkeydata) | :heavy_check_mark: | Current API key information | \{
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"expires_at": "2027-12-31T23:59:59Z",
"include_byok_in_limit": false,
"is_free_tier": false,
"is_management_key": false,
"is_provisioning_key": false,
"label": "sk-or-v1-au7...890",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"rate_limit": \{
"interval": "1h",
"note": "This field is deprecated and safe to ignore.",
"requests": 1000
},
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5
} | \ No newline at end of file diff --git a/docs/models/operations/getfilemetadatarequest.mdx b/docs/models/operations/getfilemetadatarequest.mdx index 1f008ac5c..fac3c0078 100644 --- a/docs/models/operations/getfilemetadatarequest.mdx +++ b/docs/models/operations/getfilemetadatarequest.mdx @@ -21,4 +21,4 @@ let value: GetFileMetadataRequest = { | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | | `fileId` | *string* | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | | `workspaceId` | *string* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [models.FileProvider](../../models/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 +| `provider` | [models.FileProvider](../../models/fileprovider) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | \ No newline at end of file diff --git a/docs/models/operations/getkeyresponse.mdx b/docs/models/operations/getkeyresponse.mdx index f9660c8a7..2976b462d 100644 --- a/docs/models/operations/getkeyresponse.mdx +++ b/docs/models/operations/getkeyresponse.mdx @@ -39,4 +39,4 @@ let value: GetKeyResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [operations.GetKeyData](../../models/operations/getkeydata.mdx) | :heavy_check_mark: | The API key information | \{
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"created_at": "2025-08-24T10:30:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"disabled": false,
"expires_at": "2027-12-31T23:59:59Z",
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"name": "My Production Key",
"updated_at": "2025-08-24T15:45:00Z",
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5,
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file +| `data` | [operations.GetKeyData](../../models/operations/getkeydata) | :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",
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"name": "My Production Key",
"updated_at": "2025-08-24T15:45:00Z",
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5,
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file diff --git a/docs/models/operations/getmodelsrequest.mdx b/docs/models/operations/getmodelsrequest.mdx index 1f4604f2b..7022fdaf5 100644 --- a/docs/models/operations/getmodelsrequest.mdx +++ b/docs/models/operations/getmodelsrequest.mdx @@ -19,10 +19,10 @@ let value: GetModelsRequest = {}; | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | | `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | | `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | -| `category` | [operations.GetModelsCategory](../../models/operations/getmodelscategory.mdx) | :heavy_minus_sign: | Filter models by use case category | programming | +| `category` | [operations.GetModelsCategory](../../models/operations/getmodelscategory) | :heavy_minus_sign: | Filter models by use case category | programming | | `supportedParameters` | *string* | :heavy_minus_sign: | Filter models by supported parameter (comma-separated) | temperature | | `outputModalities` | *string* | :heavy_minus_sign: | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, audio, embeddings) or "all" to include all models. Defaults to "text". | text | -| `sort` | [operations.GetModelsSort](../../models/operations/getmodelssort.mdx) | :heavy_minus_sign: | Sort the returned models server-side. Prefer this over fetching the full list and sorting client-side. Options: pricing-low-to-high, pricing-high-to-low (average prompt/completion price), context-high-to-low (context length), throughput-high-to-low, latency-low-to-high (recent median performance), most-popular, top-weekly (tokens processed in the last week), newest (creation date), intelligence-high-to-low, coding-high-to-low, agentic-high-to-low (Artificial Analysis indices), design-arena-elo-high-to-low (best Design Arena ELO across arenas). Models without a score for the chosen benchmark are placed last. When omitted, the existing default ordering is preserved. | newest | +| `sort` | [operations.GetModelsSort](../../models/operations/getmodelssort) | :heavy_minus_sign: | Sort the returned models server-side. Prefer this over fetching the full list and sorting client-side. Options: pricing-low-to-high, pricing-high-to-low (average prompt/completion price), context-high-to-low (context length), throughput-high-to-low, latency-low-to-high (recent median performance), most-popular, top-weekly (tokens processed in the last week), newest (creation date), intelligence-high-to-low, coding-high-to-low, agentic-high-to-low (Artificial Analysis indices), design-arena-elo-high-to-low (best Design Arena ELO across arenas). Models without a score for the chosen benchmark are placed last. When omitted, the existing default ordering is preserved. | newest | | `q` | *string* | :heavy_minus_sign: | Free-text search by model name or slug. | gpt-4 | | `inputModalities` | *string* | :heavy_minus_sign: | Filter models by input modality. Comma-separated list of: text, image, audio, file. | text,image | | `context` | *number* | :heavy_minus_sign: | Minimum context length (tokens). Models with smaller context are excluded. | 128000 | @@ -31,9 +31,9 @@ let value: GetModelsRequest = {}; | `arch` | *string* | :heavy_minus_sign: | Filter models by architecture/model family (e.g. GPT, Claude, Gemini, Llama). | GPT | | `modelAuthors` | *string* | :heavy_minus_sign: | Filter models by the organization that created the model. Comma-separated list of author slugs. | openai,anthropic | | `providers` | *string* | :heavy_minus_sign: | Filter models by hosting provider. Comma-separated list of provider names. | OpenAI,Anthropic | -| `distillable` | [operations.Distillable](../../models/operations/distillable.mdx) | :heavy_minus_sign: | Filter by distillation capability. "true" returns only distillable models, "false" excludes them. | true | -| `zdr` | [operations.Zdr](../../models/operations/zdr.mdx) | :heavy_minus_sign: | When set to "true", return only models with zero data retention endpoints. | true | -| `region` | [operations.Region](../../models/operations/region.mdx) | :heavy_minus_sign: | Filter to models with endpoints in the given data region. Currently only "eu" is supported. | eu | +| `distillable` | [operations.Distillable](../../models/operations/distillable) | :heavy_minus_sign: | Filter by distillation capability. "true" returns only distillable models, "false" excludes them. | true | +| `zdr` | [operations.Zdr](../../models/operations/zdr) | :heavy_minus_sign: | When set to "true", return only models with zero data retention endpoints. | true | +| `region` | [operations.Region](../../models/operations/region) | :heavy_minus_sign: | Filter to models with endpoints in the given data region. Currently only "eu" is supported. | eu | | `minOutputPrice` | *number* | :heavy_minus_sign: | Minimum completion (output) price in $/M tokens. | 0 | | `maxOutputPrice` | *number* | :heavy_minus_sign: | Maximum completion (output) price in $/M tokens. | 10 | | `minAgeDays` | *number* | :heavy_minus_sign: | Minimum model age in days since its creation date. | 0 | diff --git a/docs/models/operations/getmodelsresponse.mdx b/docs/models/operations/getmodelsresponse.mdx index 8b64ea1a6..38803b19f 100644 --- a/docs/models/operations/getmodelsresponse.mdx +++ b/docs/models/operations/getmodelsresponse.mdx @@ -59,4 +59,4 @@ let value: GetModelsResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ModelsListResponse](../../models/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` | [models.ModelsListResponse](../../models/modelslistresponse) | :heavy_check_mark: | N/A | \{
"data": [
\{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
}
],
"links": \{
"next": "/api/v1/models?offset=500\u0026limit=500"
},
"total_count": 150
} | \ No newline at end of file diff --git a/docs/models/operations/getrankingsdailyrequest.mdx b/docs/models/operations/getrankingsdailyrequest.mdx index a8d815b3d..3f34b0e2a 100644 --- a/docs/models/operations/getrankingsdailyrequest.mdx +++ b/docs/models/operations/getrankingsdailyrequest.mdx @@ -19,8 +19,8 @@ let value: GetRankingsDailyRequest = {}; | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | | `startDate` | *string* | :heavy_minus_sign: | Start of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to 30 days before `end_date`. The dataset begins at 2025-01-01; earlier values are clamped forward to that floor and the resolved value is echoed in `meta.start_date`. | 2026-04-12 | | `endDate` | *string* | :heavy_minus_sign: | End of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to the most recent completed UTC day. Must be on or after 2025-01-01; earlier values are rejected with a 400. | 2026-05-11 | -| `period` | [operations.Period](../../models/operations/period.mdx) | :heavy_minus_sign: | Time grain of each row. `day` (default) returns the per-UTC-day series; `week` buckets by ISO week start; `month` buckets by month start. With `category` or `language_type` only `week` (default) and `month` are available — `day` is rejected with a 400 because those datasets are aggregated weekly. For those sampled datasets `period=month` buckets each week by its week-start month, so totals are approximate at month boundaries. | day | -| `modality` | [operations.Modality](../../models/operations/modality.mdx) | :heavy_minus_sign: | Restrict to models for a modality surface: `text` / `image_output` match output modality, `image` / `audio` match input modality, and `tool_calling` keeps only rows that recorded at least one tool call. Exact dataset — cannot be combined with `category` or `language_type`. | text | -| `contextBucket` | [operations.ContextBucket](../../models/operations/contextbucket.mdx) | :heavy_minus_sign: | Restrict to requests whose context length falls in this bucket (`1K`, `10K`, `100K`, `1M`, or `10M`). Exact dataset — cannot be combined with `category` or `language_type`. | 100K | -| `category` | [operations.GetRankingsDailyCategory](../../models/operations/getrankingsdailycategory.mdx) | :heavy_minus_sign: | Restrict to a use-case category (e.g. `programming`, `roleplay`). Sourced from a sampled, upsampled dataset, so `total_tokens` is an estimate and is aggregated weekly (the trailing weekly bucket may include traffic past `end_date`). Cannot be combined with `modality`, `context_bucket`, or `language_type`. | programming | -| `languageType` | [operations.LanguageType](../../models/operations/languagetype.mdx) | :heavy_minus_sign: | Restrict to natural-language or programming-language tagged activity. Sourced from a sampled, upsampled dataset, so `total_tokens` is an estimate and is aggregated weekly (the trailing weekly bucket may include traffic past `end_date`). Cannot be combined with `modality`, `context_bucket`, or `category`. | natural | \ No newline at end of file +| `period` | [operations.Period](../../models/operations/period) | :heavy_minus_sign: | Time grain of each row. `day` (default) returns the per-UTC-day series; `week` buckets by ISO week start; `month` buckets by month start. With `category` or `language_type` only `week` (default) and `month` are available — `day` is rejected with a 400 because those datasets are aggregated weekly. For those sampled datasets `period=month` buckets each week by its week-start month, so totals are approximate at month boundaries. | day | +| `modality` | [operations.Modality](../../models/operations/modality) | :heavy_minus_sign: | Restrict to models for a modality surface: `text` / `image_output` match output modality, `image` / `audio` match input modality, and `tool_calling` keeps only rows that recorded at least one tool call. Exact dataset — cannot be combined with `category` or `language_type`. | text | +| `contextBucket` | [operations.ContextBucket](../../models/operations/contextbucket) | :heavy_minus_sign: | Restrict to requests whose context length falls in this bucket (`1K`, `10K`, `100K`, `1M`, or `10M`). Exact dataset — cannot be combined with `category` or `language_type`. | 100K | +| `category` | [operations.GetRankingsDailyCategory](../../models/operations/getrankingsdailycategory) | :heavy_minus_sign: | Restrict to a use-case category (e.g. `programming`, `roleplay`). Sourced from a sampled, upsampled dataset, so `total_tokens` is an estimate and is aggregated weekly (the trailing weekly bucket may include traffic past `end_date`). Cannot be combined with `modality`, `context_bucket`, or `language_type`. | programming | +| `languageType` | [operations.LanguageType](../../models/operations/languagetype) | :heavy_minus_sign: | Restrict to natural-language or programming-language tagged activity. Sourced from a sampled, upsampled dataset, so `total_tokens` is an estimate and is aggregated weekly (the trailing weekly bucket may include traffic past `end_date`). Cannot be combined with `modality`, `context_bucket`, or `category`. | natural | \ No newline at end of file diff --git a/docs/models/operations/gettaskclassificationsrequest.mdx b/docs/models/operations/gettaskclassificationsrequest.mdx index 9c26cc8ca..31e643e0a 100644 --- a/docs/models/operations/gettaskclassificationsrequest.mdx +++ b/docs/models/operations/gettaskclassificationsrequest.mdx @@ -17,4 +17,4 @@ let value: GetTaskClassificationsRequest = {}; | `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `window` | [operations.Window](../../models/operations/window.mdx) | :heavy_minus_sign: | Trailing time window for the classification data. Currently only `7d` (trailing 7 days) is supported. | 7d | \ No newline at end of file +| `window` | [operations.Window](../../models/operations/window) | :heavy_minus_sign: | Trailing time window for the classification data. Currently only `7d` (trailing 7 days) is supported. | 7d | \ No newline at end of file diff --git a/docs/models/operations/granularity.mdx b/docs/models/operations/granularity.mdx index e3b0c5ddf..3eea52b10 100644 --- a/docs/models/operations/granularity.mdx +++ b/docs/models/operations/granularity.mdx @@ -18,4 +18,4 @@ let value: Granularity = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | | `displayLabel` | *string* | :heavy_check_mark: | Human-readable label | Day | -| `name` | [operations.GranularityName](../../models/operations/granularityname.mdx) | :heavy_check_mark: | Granularity identifier | day | \ No newline at end of file +| `name` | [operations.GranularityName](../../models/operations/granularityname) | :heavy_check_mark: | Granularity identifier | day | \ No newline at end of file diff --git a/docs/models/operations/listbyokkeysrequest.mdx b/docs/models/operations/listbyokkeysrequest.mdx index 313414dea..d6fad87aa 100644 --- a/docs/models/operations/listbyokkeysrequest.mdx +++ b/docs/models/operations/listbyokkeysrequest.mdx @@ -20,4 +20,4 @@ let value: ListBYOKKeysRequest = {}; | `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | | `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | | `workspaceId` | *string* | :heavy_minus_sign: | Optional workspace ID to filter by. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | -| `provider` | [operations.Provider](../../models/operations/provider.mdx) | :heavy_minus_sign: | Optional provider slug to filter by (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | \ No newline at end of file +| `provider` | [operations.Provider](../../models/operations/provider) | :heavy_minus_sign: | Optional provider slug to filter by (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | \ No newline at end of file diff --git a/docs/models/operations/listbyokkeysresponse.mdx b/docs/models/operations/listbyokkeysresponse.mdx index 5247e5a4d..c867adb4c 100644 --- a/docs/models/operations/listbyokkeysresponse.mdx +++ b/docs/models/operations/listbyokkeysresponse.mdx @@ -33,4 +33,4 @@ let value: ListBYOKKeysResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ListBYOKKeysResponse](../../models/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",
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_fallback": 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` | [models.ListBYOKKeysResponse](../../models/listbyokkeysresponse) | :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",
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_fallback": false,
"label": "sk-...AbCd",
"name": "Production OpenAI Key",
"provider": "openai",
"sort_order": 0,
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listembeddingsmodelsresponse.mdx b/docs/models/operations/listembeddingsmodelsresponse.mdx index c8ad5c2ca..1698a319f 100644 --- a/docs/models/operations/listembeddingsmodelsresponse.mdx +++ b/docs/models/operations/listembeddingsmodelsresponse.mdx @@ -59,4 +59,4 @@ let value: ListEmbeddingsModelsResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ModelsListResponse](../../models/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` | [models.ModelsListResponse](../../models/modelslistresponse) | :heavy_check_mark: | N/A | \{
"data": [
\{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
}
],
"links": \{
"next": "/api/v1/models?offset=500\u0026limit=500"
},
"total_count": 150
} | \ No newline at end of file diff --git a/docs/models/operations/listendpointsresponse.mdx b/docs/models/operations/listendpointsresponse.mdx index af89dd006..838251ebe 100644 --- a/docs/models/operations/listendpointsresponse.mdx +++ b/docs/models/operations/listendpointsresponse.mdx @@ -73,4 +73,4 @@ let value: ListEndpointsResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [models.ListEndpointsResponse](../../models/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` | [models.ListEndpointsResponse](../../models/listendpointsresponse) | :heavy_check_mark: | List of available endpoints for a model | \{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"created": 1692901234,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"endpoints": [
\{
"context_length": 8192,
"latency_last_30m": \{
"p50": 0.25,
"p75": 0.35,
"p90": 0.48,
"p99": 0.85
},
"max_completion_tokens": 4096,
"max_prompt_tokens": 8192,
"model_id": "openai/gpt-4",
"model_name": "GPT-4",
"name": "OpenAI: GPT-4",
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"provider_name": "OpenAI",
"quantization": "fp16",
"status": 0,
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"supports_implicit_caching": true,
"tag": "openai",
"throughput_last_30m": \{
"p50": 45.2,
"p75": 38.5,
"p90": 28.3,
"p99": 15.1
},
"uptime_last_1d": 99.8,
"uptime_last_30m": 99.5,
"uptime_last_5m": 100
}
],
"id": "openai/gpt-4",
"name": "GPT-4"
} | \ No newline at end of file diff --git a/docs/models/operations/listendpointszdrresponse.mdx b/docs/models/operations/listendpointszdrresponse.mdx index 948bf9455..16534a7bd 100644 --- a/docs/models/operations/listendpointszdrresponse.mdx +++ b/docs/models/operations/listendpointszdrresponse.mdx @@ -55,4 +55,4 @@ let value: ListEndpointsZdrResponse = { | Field | Type | Required | Description | | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | -| `data` | [models.PublicEndpoint](../../models/publicendpoint.mdx)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [models.PublicEndpoint](../../models/publicendpoint)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/listfilesrequest.mdx b/docs/models/operations/listfilesrequest.mdx index aff45b94b..c8742c1fd 100644 --- a/docs/models/operations/listfilesrequest.mdx +++ b/docs/models/operations/listfilesrequest.mdx @@ -20,8 +20,8 @@ let value: ListFilesRequest = {}; | `limit` | *number* | :heavy_minus_sign: | Maximum number of files to return (1–1000). | 100 | | `cursor` | *string* | :heavy_minus_sign: | Opaque pagination cursor from a previous response. | eyJjdXJzb3IiOiJvcl9maWxlXzAxMUNOaGE4aUNKY1Uxd1hOUjZxNFY4dyJ9 | | `workspaceId` | *string* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [models.FileProvider](../../models/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 | +| `provider` | [models.FileProvider](../../models/fileprovider) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | | `after` | *string* | :heavy_minus_sign: | OpenAI-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | | `afterId` | *string* | :heavy_minus_sign: | Anthropic-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | | `beforeId` | *string* | :heavy_minus_sign: | Anthropic-style reverse cursor. Not supported by OpenRouter storage. | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `order` | [operations.Order](../../models/operations/order.mdx) | :heavy_minus_sign: | Sort direction. Only `asc` is supported by OpenRouter storage. | asc | \ No newline at end of file +| `order` | [operations.Order](../../models/operations/order) | :heavy_minus_sign: | Sort direction. Only `asc` is supported by OpenRouter storage. | asc | \ No newline at end of file diff --git a/docs/models/operations/listguardrailkeyassignmentsresponse.mdx b/docs/models/operations/listguardrailkeyassignmentsresponse.mdx index 328ca111f..2c33344b7 100644 --- a/docs/models/operations/listguardrailkeyassignmentsresponse.mdx +++ b/docs/models/operations/listguardrailkeyassignmentsresponse.mdx @@ -30,4 +30,4 @@ let value: ListGuardrailKeyAssignmentsResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ListKeyAssignmentsResponse](../../models/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` | [models.ListKeyAssignmentsResponse](../../models/listkeyassignmentsresponse) | :heavy_check_mark: | N/A | \{
"data": [
\{
"assigned_by": "user_abc123",
"created_at": "2025-08-24T10:30:00Z",
"guardrail_id": "550e8400-e29b-41d4-a716-446655440001",
"id": "550e8400-e29b-41d4-a716-446655440000",
"key_hash": "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93",
"key_label": "prod-key",
"key_name": "Production Key"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listguardrailmemberassignmentsresponse.mdx b/docs/models/operations/listguardrailmemberassignmentsresponse.mdx index 124e550dd..9276a7c55 100644 --- a/docs/models/operations/listguardrailmemberassignmentsresponse.mdx +++ b/docs/models/operations/listguardrailmemberassignmentsresponse.mdx @@ -28,4 +28,4 @@ let value: ListGuardrailMemberAssignmentsResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ListMemberAssignmentsResponse](../../models/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` | [models.ListMemberAssignmentsResponse](../../models/listmemberassignmentsresponse) | :heavy_check_mark: | N/A | \{
"data": [
\{
"assigned_by": "user_abc123",
"created_at": "2025-08-24T10:30:00Z",
"guardrail_id": "550e8400-e29b-41d4-a716-446655440001",
"id": "550e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_xyz789",
"user_id": "user_abc123"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listguardrailsresponse.mdx b/docs/models/operations/listguardrailsresponse.mdx index 88572a7b5..936f8859a 100644 --- a/docs/models/operations/listguardrailsresponse.mdx +++ b/docs/models/operations/listguardrailsresponse.mdx @@ -27,4 +27,4 @@ let value: ListGuardrailsResponse = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ListGuardrailsResponse](../../models/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",
"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` | [models.ListGuardrailsResponse](../../models/listguardrailsresponse) | :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",
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"include_byok_in_budgets": false,
"limit_usd": 100,
"name": "Production Guardrail",
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listkeyassignmentsresponse.mdx b/docs/models/operations/listkeyassignmentsresponse.mdx index 199a6db53..a46bdb14e 100644 --- a/docs/models/operations/listkeyassignmentsresponse.mdx +++ b/docs/models/operations/listkeyassignmentsresponse.mdx @@ -30,4 +30,4 @@ let value: ListKeyAssignmentsResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ListKeyAssignmentsResponse](../../models/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` | [models.ListKeyAssignmentsResponse](../../models/listkeyassignmentsresponse) | :heavy_check_mark: | N/A | \{
"data": [
\{
"assigned_by": "user_abc123",
"created_at": "2025-08-24T10:30:00Z",
"guardrail_id": "550e8400-e29b-41d4-a716-446655440001",
"id": "550e8400-e29b-41d4-a716-446655440000",
"key_hash": "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93",
"key_label": "prod-key",
"key_name": "Production Key"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listmemberassignmentsresponse.mdx b/docs/models/operations/listmemberassignmentsresponse.mdx index c435951eb..431dd5f85 100644 --- a/docs/models/operations/listmemberassignmentsresponse.mdx +++ b/docs/models/operations/listmemberassignmentsresponse.mdx @@ -28,4 +28,4 @@ let value: ListMemberAssignmentsResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ListMemberAssignmentsResponse](../../models/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` | [models.ListMemberAssignmentsResponse](../../models/listmemberassignmentsresponse) | :heavy_check_mark: | N/A | \{
"data": [
\{
"assigned_by": "user_abc123",
"created_at": "2025-08-24T10:30:00Z",
"guardrail_id": "550e8400-e29b-41d4-a716-446655440001",
"id": "550e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_xyz789",
"user_id": "user_abc123"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listmodelsuserresponse.mdx b/docs/models/operations/listmodelsuserresponse.mdx index 9fb49555f..6f7cbdd9a 100644 --- a/docs/models/operations/listmodelsuserresponse.mdx +++ b/docs/models/operations/listmodelsuserresponse.mdx @@ -59,4 +59,4 @@ let value: ListModelsUserResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ModelsListResponse](../../models/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` | [models.ModelsListResponse](../../models/modelslistresponse) | :heavy_check_mark: | N/A | \{
"data": [
\{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
}
],
"links": \{
"next": "/api/v1/models?offset=500\u0026limit=500"
},
"total_count": 150
} | \ No newline at end of file diff --git a/docs/models/operations/listobservabilitydestinationsresponse.mdx b/docs/models/operations/listobservabilitydestinationsresponse.mdx index 1399a2612..b3ec75906 100644 --- a/docs/models/operations/listobservabilitydestinationsresponse.mdx +++ b/docs/models/operations/listobservabilitydestinationsresponse.mdx @@ -38,4 +38,4 @@ let value: ListObservabilityDestinationsResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ListObservabilityDestinationsResponse](../../models/listobservabilitydestinationsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"api_key_hashes": null,
"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,
"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` | [models.ListObservabilityDestinationsResponse](../../models/listobservabilitydestinationsresponse) | :heavy_check_mark: | N/A | \{
"data": [
\{
"api_key_hashes": null,
"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,
"sampling_rate": 1,
"type": "langfuse",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listorganizationmembersdata.mdx b/docs/models/operations/listorganizationmembersdata.mdx index 65815cfff..5a8a70056 100644 --- a/docs/models/operations/listorganizationmembersdata.mdx +++ b/docs/models/operations/listorganizationmembersdata.mdx @@ -24,4 +24,4 @@ let value: ListOrganizationMembersData = { | `firstName` | *string* | :heavy_check_mark: | First name of the member | Jane | | `id` | *string* | :heavy_check_mark: | User ID of the organization member | user_2dHFtVWx2n56w6HkM0000000000 | | `lastName` | *string* | :heavy_check_mark: | Last name of the member | Doe | -| `role` | [operations.Role](../../models/operations/role.mdx) | :heavy_check_mark: | Role of the member in the organization | org:member | \ No newline at end of file +| `role` | [operations.Role](../../models/operations/role) | :heavy_check_mark: | Role of the member in the organization | org:member | \ No newline at end of file diff --git a/docs/models/operations/listorganizationmembersresponse.mdx b/docs/models/operations/listorganizationmembersresponse.mdx index de6e7343f..c40da8536 100644 --- a/docs/models/operations/listorganizationmembersresponse.mdx +++ b/docs/models/operations/listorganizationmembersresponse.mdx @@ -19,4 +19,4 @@ let value: ListOrganizationMembersResponse = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `result` | [operations.ListOrganizationMembersResponseBody](../../models/operations/listorganizationmembersresponsebody.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `result` | [operations.ListOrganizationMembersResponseBody](../../models/operations/listorganizationmembersresponsebody) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/listorganizationmembersresponsebody.mdx b/docs/models/operations/listorganizationmembersresponsebody.mdx index 332b12517..c5dfca983 100644 --- a/docs/models/operations/listorganizationmembersresponsebody.mdx +++ b/docs/models/operations/listorganizationmembersresponsebody.mdx @@ -19,5 +19,5 @@ let value: ListOrganizationMembersResponseBody = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `data` | [operations.ListOrganizationMembersData](../../models/operations/listorganizationmembersdata.mdx)[] | :heavy_check_mark: | List of organization members | | +| `data` | [operations.ListOrganizationMembersData](../../models/operations/listorganizationmembersdata)[] | :heavy_check_mark: | List of organization members | | | `totalCount` | *number* | :heavy_check_mark: | Total number of members in the organization | 25 | \ No newline at end of file diff --git a/docs/models/operations/listpresetsresponse.mdx b/docs/models/operations/listpresetsresponse.mdx index e75f51a5d..178031bd4 100644 --- a/docs/models/operations/listpresetsresponse.mdx +++ b/docs/models/operations/listpresetsresponse.mdx @@ -33,4 +33,4 @@ let value: ListPresetsResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `result` | [models.ListPresetsResponse](../../models/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` | [models.ListPresetsResponse](../../models/listpresetsresponse) | :heavy_check_mark: | N/A | \{
"data": [
\{
"created_at": "2026-04-20T10:00:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"description": null,
"designated_version_id": "550e8400-e29b-41d4-a716-446655440000",
"id": "650e8400-e29b-41d4-a716-446655440001",
"name": "my-preset",
"slug": "my-preset",
"status": "active",
"status_updated_at": null,
"updated_at": "2026-04-20T10:00:00Z",
"workspace_id": "750e8400-e29b-41d4-a716-446655440002"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listpresetversionsresponse.mdx b/docs/models/operations/listpresetversionsresponse.mdx index 6eba04305..bb54ea739 100644 --- a/docs/models/operations/listpresetversionsresponse.mdx +++ b/docs/models/operations/listpresetversionsresponse.mdx @@ -33,4 +33,4 @@ let value: ListPresetVersionsResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `result` | [models.ListPresetVersionsResponse](../../models/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` | [models.ListPresetVersionsResponse](../../models/listpresetversionsresponse) | :heavy_check_mark: | N/A | \{
"data": [
\{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listprovidersdata.mdx b/docs/models/operations/listprovidersdata.mdx index 32ef99d46..f88bfac85 100644 --- a/docs/models/operations/listprovidersdata.mdx +++ b/docs/models/operations/listprovidersdata.mdx @@ -18,8 +18,8 @@ let value: ListProvidersData = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `datacenters` | [operations.Datacenter](../../models/operations/datacenter.mdx)[] | :heavy_minus_sign: | ISO 3166-1 Alpha-2 country codes of the provider datacenter locations | [
"US",
"IE"
] | -| `headquarters` | [operations.Headquarters](../../models/operations/headquarters.mdx) | :heavy_minus_sign: | ISO 3166-1 Alpha-2 country code of the provider headquarters | US | +| `datacenters` | [operations.Datacenter](../../models/operations/datacenter)[] | :heavy_minus_sign: | ISO 3166-1 Alpha-2 country codes of the provider datacenter locations | [
"US",
"IE"
] | +| `headquarters` | [operations.Headquarters](../../models/operations/headquarters) | :heavy_minus_sign: | ISO 3166-1 Alpha-2 country code of the provider headquarters | US | | `name` | *string* | :heavy_check_mark: | Display name of the provider | OpenAI | | `privacyPolicyUrl` | *string* | :heavy_check_mark: | URL to the provider's privacy policy | https://openai.com/privacy | | `slug` | *string* | :heavy_check_mark: | URL-friendly identifier for the provider | openai | diff --git a/docs/models/operations/listprovidersresponse.mdx b/docs/models/operations/listprovidersresponse.mdx index 4cdfd035f..4705baa5c 100644 --- a/docs/models/operations/listprovidersresponse.mdx +++ b/docs/models/operations/listprovidersresponse.mdx @@ -24,4 +24,4 @@ let value: ListProvidersResponse = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `data` | [operations.ListProvidersData](../../models/operations/listprovidersdata.mdx)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [operations.ListProvidersData](../../models/operations/listprovidersdata)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/listresponse.mdx b/docs/models/operations/listresponse.mdx index e3820e26d..cf6a8e627 100644 --- a/docs/models/operations/listresponse.mdx +++ b/docs/models/operations/listresponse.mdx @@ -41,4 +41,4 @@ let value: ListResponse = { | Field | Type | Required | Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `data` | [operations.ListData](../../models/operations/listdata.mdx)[] | :heavy_check_mark: | List of API keys | \ No newline at end of file +| `data` | [operations.ListData](../../models/operations/listdata)[] | :heavy_check_mark: | List of API keys | \ No newline at end of file diff --git a/docs/models/operations/listworkspacemembersresponse.mdx b/docs/models/operations/listworkspacemembersresponse.mdx index f847bcd83..14f16a351 100644 --- a/docs/models/operations/listworkspacemembersresponse.mdx +++ b/docs/models/operations/listworkspacemembersresponse.mdx @@ -27,4 +27,4 @@ let value: ListWorkspaceMembersResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ListWorkspaceMembersResponse](../../models/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` | [models.ListWorkspaceMembersResponse](../../models/listworkspacemembersresponse) | :heavy_check_mark: | N/A | \{
"data": [
\{
"created_at": "2025-08-24T10:30:00Z",
"id": "660e8400-e29b-41d4-a716-446655440000",
"role": "member",
"user_id": "user_abc123",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listworkspacesresponse.mdx b/docs/models/operations/listworkspacesresponse.mdx index de9da9702..f87c1e1df 100644 --- a/docs/models/operations/listworkspacesresponse.mdx +++ b/docs/models/operations/listworkspacesresponse.mdx @@ -38,4 +38,4 @@ let value: ListWorkspacesResponse = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ListWorkspacesResponse](../../models/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",
"id": "550e8400-e29b-41d4-a716-446655440000",
"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` | [models.ListWorkspacesResponse](../../models/listworkspacesresponse) | :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",
"id": "550e8400-e29b-41d4-a716-446655440000",
"io_logging_api_key_ids": null,
"io_logging_sampling_rate": 1,
"is_data_discount_logging_enabled": true,
"is_observability_broadcast_enabled": false,
"is_observability_io_logging_enabled": false,
"name": "Production",
"slug": "production",
"updated_at": "2025-08-24T15:45:00Z"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/metric.mdx b/docs/models/operations/metric.mdx index baf32b1b8..fb61ac9ba 100644 --- a/docs/models/operations/metric.mdx +++ b/docs/models/operations/metric.mdx @@ -19,7 +19,7 @@ let value: Metric = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `displayFormat` | [operations.DisplayFormat](../../models/operations/displayformat.mdx) | :heavy_check_mark: | How this metric value should be formatted for display (e.g. percent → multiply by 100 and append %, currency → prefix with $) | number | +| `displayFormat` | [operations.DisplayFormat](../../models/operations/displayformat) | :heavy_check_mark: | How this metric value should be formatted for display (e.g. percent → multiply by 100 and append %, currency → prefix with $) | number | | `displayLabel` | *string* | :heavy_check_mark: | Human-readable label | Request Count | | `isRate` | *boolean* | :heavy_check_mark: | Whether this metric is a rate/ratio (averaged, not summed) | | | `name` | *string* | :heavy_check_mark: | Metric identifier used in query requests | request_count | \ No newline at end of file diff --git a/docs/models/operations/operator.mdx b/docs/models/operations/operator.mdx index 647d5dba1..21955dea2 100644 --- a/docs/models/operations/operator.mdx +++ b/docs/models/operations/operator.mdx @@ -17,5 +17,5 @@ let value: Operator = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `name` | [operations.OperatorName](../../models/operations/operatorname.mdx) | :heavy_check_mark: | Operator identifier used in filter definitions | eq | -| `valueType` | [operations.ValueType](../../models/operations/valuetype.mdx) | :heavy_check_mark: | Whether the operator expects a single value or an array | | \ No newline at end of file +| `name` | [operations.OperatorName](../../models/operations/operatorname) | :heavy_check_mark: | Operator identifier used in filter definitions | eq | +| `valueType` | [operations.ValueType](../../models/operations/valuetype) | :heavy_check_mark: | Whether the operator expects a single value or an array | | \ No newline at end of file diff --git a/docs/models/operations/orderby.mdx b/docs/models/operations/orderby.mdx index c0a5b8289..de7143b2e 100644 --- a/docs/models/operations/orderby.mdx +++ b/docs/models/operations/orderby.mdx @@ -17,5 +17,5 @@ let value: OrderBy = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `direction` | [operations.Direction](../../models/operations/direction.mdx) | :heavy_check_mark: | N/A | | +| `direction` | [operations.Direction](../../models/operations/direction) | :heavy_check_mark: | N/A | | | `field` | *string* | :heavy_check_mark: | Field to order by: a metric included in `metrics` (or "request_count", which may be ordered by without being requested), a requested dimension, or "date". | request_count | \ No newline at end of file diff --git a/docs/models/operations/queryanalyticsdata2.mdx b/docs/models/operations/queryanalyticsdata2.mdx index 5df8c58fb..431365e6f 100644 --- a/docs/models/operations/queryanalyticsdata2.mdx +++ b/docs/models/operations/queryanalyticsdata2.mdx @@ -24,6 +24,6 @@ let value: QueryAnalyticsData2 = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `cachedAt` | *number* | :heavy_minus_sign: | N/A | -| `data` | [operations.QueryAnalyticsData1](../../models/operations/queryanalyticsdata1.mdx)[] | :heavy_check_mark: | N/A | -| `metadata` | [operations.Metadata](../../models/operations/metadata.mdx) | :heavy_check_mark: | N/A | +| `data` | [operations.QueryAnalyticsData1](../../models/operations/queryanalyticsdata1)[] | :heavy_check_mark: | N/A | +| `metadata` | [operations.Metadata](../../models/operations/metadata) | :heavy_check_mark: | N/A | | `warnings` | *string*[] | :heavy_minus_sign: | Warnings about filter resolution issues (e.g. unresolvable api_key_id hashes). The query still runs normally; these inform the caller that some filter values could not be resolved. | \ No newline at end of file diff --git a/docs/models/operations/queryanalyticsrequest.mdx b/docs/models/operations/queryanalyticsrequest.mdx index 6239756b4..6e030661f 100644 --- a/docs/models/operations/queryanalyticsrequest.mdx +++ b/docs/models/operations/queryanalyticsrequest.mdx @@ -23,4 +23,4 @@ let value: QueryAnalyticsRequest = { | `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `requestBody` | [operations.QueryAnalyticsRequestBody](../../models/operations/queryanalyticsrequestbody.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `requestBody` | [operations.QueryAnalyticsRequestBody](../../models/operations/queryanalyticsrequestbody) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/queryanalyticsrequestbody.mdx b/docs/models/operations/queryanalyticsrequestbody.mdx index ee21c2578..836c2286a 100644 --- a/docs/models/operations/queryanalyticsrequestbody.mdx +++ b/docs/models/operations/queryanalyticsrequestbody.mdx @@ -18,13 +18,13 @@ let value: QueryAnalyticsRequestBody = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `classifierDimensions` | [operations.ClassifierDimensions](../../models/operations/classifierdimensions.mdx) | :heavy_minus_sign: | Group results by custom classifier tags, breaking down metrics by the specified dimension values. Requires an active classifier on the workspace. | | -| `classifierFilters` | [operations.ClassifierFilters](../../models/operations/classifierfilters.mdx) | :heavy_minus_sign: | Filter results to generations with specific classifier tag values. Can be combined with classifier_dimensions (must use the same classifier_id) or used independently with standard dimensions. | | +| `classifierDimensions` | [operations.ClassifierDimensions](../../models/operations/classifierdimensions) | :heavy_minus_sign: | Group results by custom classifier tags, breaking down metrics by the specified dimension values. Requires an active classifier on the workspace. | | +| `classifierFilters` | [operations.ClassifierFilters](../../models/operations/classifierfilters) | :heavy_minus_sign: | Filter results to generations with specific classifier tag values. Can be combined with classifier_dimensions (must use the same classifier_id) or used independently with standard dimensions. | | | `dimensions` | *string*[] | :heavy_minus_sign: | N/A | | -| `filters` | [operations.Filter](../../models/operations/filter.mdx)[] | :heavy_minus_sign: | N/A | | +| `filters` | [operations.Filter](../../models/operations/filter)[] | :heavy_minus_sign: | N/A | | | `granularity` | *string* | :heavy_minus_sign: | Time granularity | day | | `groupLimit` | *number* | :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` | *number* | :heavy_minus_sign: | Maximum total rows returned. Defaults to 1000. On time-series queries with dimensions and no explicit group_limit, the server may raise this to accommodate the expected number of unique time-bucket/dimension combinations. | | | `metrics` | *string*[] | :heavy_check_mark: | N/A | | -| `orderBy` | [operations.OrderBy](../../models/operations/orderby.mdx) | :heavy_minus_sign: | N/A | | -| `timeRange` | [operations.TimeRange](../../models/operations/timerange.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `orderBy` | [operations.OrderBy](../../models/operations/orderby) | :heavy_minus_sign: | N/A | | +| `timeRange` | [operations.TimeRange](../../models/operations/timerange) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/queryanalyticsresponse.mdx b/docs/models/operations/queryanalyticsresponse.mdx index 772a72ac1..b113a43e3 100644 --- a/docs/models/operations/queryanalyticsresponse.mdx +++ b/docs/models/operations/queryanalyticsresponse.mdx @@ -27,4 +27,4 @@ let value: QueryAnalyticsResponse = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `data` | [operations.QueryAnalyticsData2](../../models/operations/queryanalyticsdata2.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [operations.QueryAnalyticsData2](../../models/operations/queryanalyticsdata2) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/result.mdx b/docs/models/operations/result.mdx index a0a09a424..7533f9cb6 100644 --- a/docs/models/operations/result.mdx +++ b/docs/models/operations/result.mdx @@ -20,6 +20,6 @@ let value: Result = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `document` | [operations.DocumentResponse](../../models/operations/documentresponse.mdx) | :heavy_check_mark: | The document object echoing the original input (text and/or image) | | +| `document` | [operations.DocumentResponse](../../models/operations/documentresponse) | :heavy_check_mark: | The document object echoing the original input (text and/or image) | | | `index` | *number* | :heavy_check_mark: | Index of the document in the original input list | 0 | | `relevanceScore` | *number* | :heavy_check_mark: | Relevance score of the document to the query | 0.98 | \ No newline at end of file diff --git a/docs/models/operations/sendchatcompletionrequestrequest.mdx b/docs/models/operations/sendchatcompletionrequestrequest.mdx index 1b6f6f825..983f598fa 100644 --- a/docs/models/operations/sendchatcompletionrequestrequest.mdx +++ b/docs/models/operations/sendchatcompletionrequestrequest.mdx @@ -30,5 +30,5 @@ let value: SendChatCompletionRequestRequest = { | `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `xOpenRouterMetadata` | [models.MetadataLevel](../../models/metadatalevel.mdx) | :heavy_minus_sign: | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility. | enabled | -| `chatRequest` | [models.ChatRequest](../../models/chatrequest.mdx) | :heavy_check_mark: | N/A | \{
"max_tokens": 150,
"messages": [
\{
"content": "You are a helpful assistant.",
"role": "system"
},
\{
"content": "What is the capital of France?",
"role": "user"
}
],
"model": "openai/gpt-4",
"temperature": 0.7
} | \ No newline at end of file +| `xOpenRouterMetadata` | [models.MetadataLevel](../../models/metadatalevel) | :heavy_minus_sign: | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility. | enabled | +| `chatRequest` | [models.ChatRequest](../../models/chatrequest) | :heavy_check_mark: | N/A | \{
"max_tokens": 150,
"messages": [
\{
"content": "You are a helpful assistant.",
"role": "system"
},
\{
"content": "What is the capital of France?",
"role": "user"
}
],
"model": "openai/gpt-4",
"temperature": 0.7
} | \ No newline at end of file diff --git a/docs/models/operations/submitgenerationfeedbackrequest.mdx b/docs/models/operations/submitgenerationfeedbackrequest.mdx index f2cd7ab74..d6b034d78 100644 --- a/docs/models/operations/submitgenerationfeedbackrequest.mdx +++ b/docs/models/operations/submitgenerationfeedbackrequest.mdx @@ -22,4 +22,4 @@ let value: SubmitGenerationFeedbackRequest = { | `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `submitGenerationFeedbackRequest` | [models.SubmitGenerationFeedbackRequest](../../models/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 +| `submitGenerationFeedbackRequest` | [models.SubmitGenerationFeedbackRequest](../../models/submitgenerationfeedbackrequest) | :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/models/operations/updatebyokkeyrequest.mdx b/docs/models/operations/updatebyokkeyrequest.mdx index 55b9afe5b..9206f1abe 100644 --- a/docs/models/operations/updatebyokkeyrequest.mdx +++ b/docs/models/operations/updatebyokkeyrequest.mdx @@ -21,4 +21,4 @@ let value: UpdateBYOKKeyRequest = { | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | | `id` | *string* | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | -| `updateBYOKKeyRequest` | [models.UpdateBYOKKeyRequest](../../models/updatebyokkeyrequest.mdx) | :heavy_check_mark: | N/A | \{
"disabled": false,
"name": "Updated OpenAI Key"
} | \ No newline at end of file +| `updateBYOKKeyRequest` | [models.UpdateBYOKKeyRequest](../../models/updatebyokkeyrequest) | :heavy_check_mark: | N/A | \{
"disabled": false,
"name": "Updated OpenAI Key"
} | \ No newline at end of file diff --git a/docs/models/operations/updateguardrailrequest.mdx b/docs/models/operations/updateguardrailrequest.mdx index e424c2726..987f59c46 100644 --- a/docs/models/operations/updateguardrailrequest.mdx +++ b/docs/models/operations/updateguardrailrequest.mdx @@ -21,4 +21,4 @@ let value: UpdateGuardrailRequest = { | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | | `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail to update | 550e8400-e29b-41d4-a716-446655440000 | -| `updateGuardrailRequest` | [models.UpdateGuardrailRequest](../../models/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 +| `updateGuardrailRequest` | [models.UpdateGuardrailRequest](../../models/updateguardrailrequest) | :heavy_check_mark: | N/A | \{
"description": "Updated description",
"limit_usd": 75,
"name": "Updated Guardrail Name",
"reset_interval": "weekly"
} | \ No newline at end of file diff --git a/docs/models/operations/updatekeysrequest.mdx b/docs/models/operations/updatekeysrequest.mdx index 9fc33a025..9ae0c5cc7 100644 --- a/docs/models/operations/updatekeysrequest.mdx +++ b/docs/models/operations/updatekeysrequest.mdx @@ -21,4 +21,4 @@ let value: UpdateKeysRequest = { | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | | `hash` | *string* | :heavy_check_mark: | The hash identifier of the API key to update | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `requestBody` | [operations.UpdateKeysRequestBody](../../models/operations/updatekeysrequestbody.mdx) | :heavy_check_mark: | N/A | \{
"disabled": false,
"include_byok_in_limit": true,
"limit": 75,
"limit_reset": "daily",
"name": "Updated API Key Name"
} | \ No newline at end of file +| `requestBody` | [operations.UpdateKeysRequestBody](../../models/operations/updatekeysrequestbody) | :heavy_check_mark: | N/A | \{
"disabled": false,
"include_byok_in_limit": true,
"limit": 75,
"limit_reset": "daily",
"name": "Updated API Key Name"
} | \ No newline at end of file diff --git a/docs/models/operations/updatekeysrequestbody.mdx b/docs/models/operations/updatekeysrequestbody.mdx index 48d6a8ba8..36e0d35e4 100644 --- a/docs/models/operations/updatekeysrequestbody.mdx +++ b/docs/models/operations/updatekeysrequestbody.mdx @@ -17,5 +17,5 @@ let value: UpdateKeysRequestBody = {}; | `disabled` | *boolean* | :heavy_minus_sign: | Whether to disable the API key | false | | `includeByokInLimit` | *boolean* | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | | `limit` | *number* | :heavy_minus_sign: | New spending limit for the API key in USD | 75 | -| `limitReset` | [operations.UpdateKeysLimitReset](../../models/operations/updatekeyslimitreset.mdx) | :heavy_minus_sign: | New limit reset type for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday. | daily | +| `limitReset` | [operations.UpdateKeysLimitReset](../../models/operations/updatekeyslimitreset) | :heavy_minus_sign: | New limit reset type for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday. | daily | | `name` | *string* | :heavy_minus_sign: | New name for the API key | Updated API Key Name | \ No newline at end of file diff --git a/docs/models/operations/updatekeysresponse.mdx b/docs/models/operations/updatekeysresponse.mdx index aa5432bba..0e1e4272d 100644 --- a/docs/models/operations/updatekeysresponse.mdx +++ b/docs/models/operations/updatekeysresponse.mdx @@ -39,4 +39,4 @@ let value: UpdateKeysResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [operations.UpdateKeysData](../../models/operations/updatekeysdata.mdx) | :heavy_check_mark: | The updated API key information | \{
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"created_at": "2025-08-24T10:30:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"disabled": false,
"expires_at": "2027-12-31T23:59:59Z",
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"name": "My Production Key",
"updated_at": "2025-08-24T15:45:00Z",
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5,
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file +| `data` | [operations.UpdateKeysData](../../models/operations/updatekeysdata) | :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",
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"name": "My Production Key",
"updated_at": "2025-08-24T15:45:00Z",
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5,
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file diff --git a/docs/models/operations/updateobservabilitydestinationrequest.mdx b/docs/models/operations/updateobservabilitydestinationrequest.mdx index 72e84345c..d4f5ec238 100644 --- a/docs/models/operations/updateobservabilitydestinationrequest.mdx +++ b/docs/models/operations/updateobservabilitydestinationrequest.mdx @@ -21,4 +21,4 @@ let value: UpdateObservabilityDestinationRequest = { | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | | `id` | *string* | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `updateObservabilityDestinationRequest` | [models.UpdateObservabilityDestinationRequest](../../models/updateobservabilitydestinationrequest.mdx) | :heavy_check_mark: | N/A | \{
"enabled": false,
"name": "Updated Langfuse"
} | \ No newline at end of file +| `updateObservabilityDestinationRequest` | [models.UpdateObservabilityDestinationRequest](../../models/updateobservabilitydestinationrequest) | :heavy_check_mark: | N/A | \{
"enabled": false,
"name": "Updated Langfuse"
} | \ No newline at end of file diff --git a/docs/models/operations/updateworkspacerequest.mdx b/docs/models/operations/updateworkspacerequest.mdx index 3e42ff583..2ec34ca3e 100644 --- a/docs/models/operations/updateworkspacerequest.mdx +++ b/docs/models/operations/updateworkspacerequest.mdx @@ -21,4 +21,4 @@ let value: UpdateWorkspaceRequest = { | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | | `id` | *string* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `updateWorkspaceRequest` | [models.UpdateWorkspaceRequest](../../models/updateworkspacerequest.mdx) | :heavy_check_mark: | N/A | \{
"name": "Updated Workspace",
"slug": "updated-workspace"
} | \ No newline at end of file +| `updateWorkspaceRequest` | [models.UpdateWorkspaceRequest](../../models/updateworkspacerequest) | :heavy_check_mark: | N/A | \{
"name": "Updated Workspace",
"slug": "updated-workspace"
} | \ No newline at end of file diff --git a/docs/models/operations/uploadfilerequest.mdx b/docs/models/operations/uploadfilerequest.mdx index 479920f14..c8b327605 100644 --- a/docs/models/operations/uploadfilerequest.mdx +++ b/docs/models/operations/uploadfilerequest.mdx @@ -18,5 +18,5 @@ import { UploadFileRequest } from "@openrouter/sdk/models/operations"; | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | | `workspaceId` | *string* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [models.FileProvider](../../models/fileprovider.mdx) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | -| `requestBody` | [operations.UploadFileRequestBody](../../models/operations/uploadfilerequestbody.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `provider` | [models.FileProvider](../../models/fileprovider) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | +| `requestBody` | [operations.UploadFileRequestBody](../../models/operations/uploadfilerequestbody) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/uploadfilerequestbody.mdx b/docs/models/operations/uploadfilerequestbody.mdx index 8c2604b14..9b9ec2521 100644 --- a/docs/models/operations/uploadfilerequestbody.mdx +++ b/docs/models/operations/uploadfilerequestbody.mdx @@ -14,4 +14,4 @@ import { UploadFileRequestBody } from "@openrouter/sdk/models/operations"; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `file` | [File](https://developer.mozilla.org/en-US/docs/Web/API/File) \| [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) \| [operations.UploadFileFile](../../models/operations/uploadfilefile.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `file` | [File](https://developer.mozilla.org/en-US/docs/Web/API/File) \| [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) \| [operations.UploadFileFile](../../models/operations/uploadfilefile) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/upsertworkspacebudgetrequest.mdx b/docs/models/operations/upsertworkspacebudgetrequest.mdx index dc113e3ca..9cca87aae 100644 --- a/docs/models/operations/upsertworkspacebudgetrequest.mdx +++ b/docs/models/operations/upsertworkspacebudgetrequest.mdx @@ -24,5 +24,5 @@ let value: UpsertWorkspaceBudgetRequest = { | `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | | `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | | `id` | *string* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `interval` | [models.WorkspaceBudgetInterval](../../models/workspacebudgetinterval.mdx) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | -| `upsertWorkspaceBudgetRequest` | [models.UpsertWorkspaceBudgetRequest](../../models/upsertworkspacebudgetrequest.mdx) | :heavy_check_mark: | N/A | \{
"limit_usd": 100
} | \ No newline at end of file +| `interval` | [models.WorkspaceBudgetInterval](../../models/workspacebudgetinterval) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | +| `upsertWorkspaceBudgetRequest` | [models.UpsertWorkspaceBudgetRequest](../../models/upsertworkspacebudgetrequest) | :heavy_check_mark: | N/A | \{
"limit_usd": 100
} | \ No newline at end of file diff --git a/docs/models/outputadvisorservertoolitem.mdx b/docs/models/outputadvisorservertoolitem.mdx index 194b0ff0e..45aa2a8c5 100644 --- a/docs/models/outputadvisorservertoolitem.mdx +++ b/docs/models/outputadvisorservertoolitem.mdx @@ -25,5 +25,5 @@ let value: OutputAdvisorServerToolItem = { | `instanceName` | *string* | :heavy_minus_sign: | Provider-safe function name of the specific advisor instance that produced this item (e.g. `openrouter_advisor__1`). Present only when more than one advisor tool is configured; omitted for the default single advisor. Echo this field back unchanged so the advisor's cross-request memory stays namespaced to the correct instance. This identity is positional: it is derived from the index of the advisor entry in the request `tools` array, so clients must keep the order of advisor tool entries stable across requests in a conversation. Reordering or inserting advisor entries shifts these names and causes each advisor's cross-request memory to be attributed to the wrong instance. | openrouter_advisor__1 | | `model` | *string* | :heavy_minus_sign: | Slug of the advisor model that was consulted. | | | `prompt` | *string* | :heavy_minus_sign: | The prompt the executor sent to the advisor. | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputAdvisorServerToolItemType](../models/outputadvisorservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `status` | [models.ToolCallStatus](../models/toolcallstatus) | :heavy_check_mark: | N/A | completed | +| `type` | [models.OutputAdvisorServerToolItemType](../models/outputadvisorservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/outputapplypatchcallitem.mdx b/docs/models/outputapplypatchcallitem.mdx index b3d2c3dbc..995c9e751 100644 --- a/docs/models/outputapplypatchcallitem.mdx +++ b/docs/models/outputapplypatchcallitem.mdx @@ -29,5 +29,5 @@ let value: OutputApplyPatchCallItem = { | `callId` | *string* | :heavy_check_mark: | N/A | | | `id` | *string* | :heavy_check_mark: | N/A | | | `operation` | *models.ApplyPatchCallOperation* | :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` | [models.ApplyPatchCallStatus](../models/applypatchcallstatus.mdx) | :heavy_check_mark: | Lifecycle state of an `apply_patch_call` output item. | completed | +| `status` | [models.ApplyPatchCallStatus](../models/applypatchcallstatus) | :heavy_check_mark: | Lifecycle state of an `apply_patch_call` output item. | completed | | `type` | *"apply_patch_call"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/outputapplypatchservertoolitem.mdx b/docs/models/outputapplypatchservertoolitem.mdx index b9f17b662..5de250880 100644 --- a/docs/models/outputapplypatchservertoolitem.mdx +++ b/docs/models/outputapplypatchservertoolitem.mdx @@ -22,5 +22,5 @@ let value: OutputApplyPatchServerToolItem = { | `callId` | *string* | :heavy_minus_sign: | N/A | | | `id` | *string* | :heavy_minus_sign: | N/A | | | `operation` | *models.ApplyPatchCallOperation* | :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` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputApplyPatchServerToolItemType](../models/outputapplypatchservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `status` | [models.ToolCallStatus](../models/toolcallstatus) | :heavy_check_mark: | N/A | completed | +| `type` | [models.OutputApplyPatchServerToolItemType](../models/outputapplypatchservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/outputbashservertoolitem.mdx b/docs/models/outputbashservertoolitem.mdx index b4296ed77..eb9c006c2 100644 --- a/docs/models/outputbashservertoolitem.mdx +++ b/docs/models/outputbashservertoolitem.mdx @@ -24,7 +24,7 @@ let value: OutputBashServerToolItem = { | `command` | *string* | :heavy_minus_sign: | N/A | | | `exitCode` | *number* | :heavy_minus_sign: | N/A | | | `id` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `status` | [models.ToolCallStatus](../models/toolcallstatus) | :heavy_check_mark: | N/A | completed | | `stderr` | *string* | :heavy_minus_sign: | N/A | | | `stdout` | *string* | :heavy_minus_sign: | N/A | | -| `type` | [models.OutputBashServerToolItemType](../models/outputbashservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `type` | [models.OutputBashServerToolItemType](../models/outputbashservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/outputbrowseruseservertoolitem.mdx b/docs/models/outputbrowseruseservertoolitem.mdx index b32129b62..8e4a18b9e 100644 --- a/docs/models/outputbrowseruseservertoolitem.mdx +++ b/docs/models/outputbrowseruseservertoolitem.mdx @@ -22,5 +22,5 @@ let value: OutputBrowserUseServerToolItem = { | `action` | *string* | :heavy_minus_sign: | N/A | | | `id` | *string* | :heavy_minus_sign: | N/A | | | `screenshotB64` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputBrowserUseServerToolItemType](../models/outputbrowseruseservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `status` | [models.ToolCallStatus](../models/toolcallstatus) | :heavy_check_mark: | N/A | completed | +| `type` | [models.OutputBrowserUseServerToolItemType](../models/outputbrowseruseservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/outputcodeinterpretercallitem.mdx b/docs/models/outputcodeinterpretercallitem.mdx index d1a0f8f14..b1408742e 100644 --- a/docs/models/outputcodeinterpretercallitem.mdx +++ b/docs/models/outputcodeinterpretercallitem.mdx @@ -32,5 +32,5 @@ let value: OutputCodeInterpreterCallItem = { | `containerId` | *string* | :heavy_check_mark: | N/A | | | `id` | *string* | :heavy_check_mark: | N/A | | | `outputs` | *models.OutputCodeInterpreterCallItemOutputUnion*[] | :heavy_check_mark: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.TypeCodeInterpreterCall](../models/typecodeinterpretercall.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `status` | [models.ToolCallStatus](../models/toolcallstatus) | :heavy_check_mark: | N/A | completed | +| `type` | [models.TypeCodeInterpreterCall](../models/typecodeinterpretercall) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/outputcodeinterpreterservertoolitem.mdx b/docs/models/outputcodeinterpreterservertoolitem.mdx index dde7b1d1a..507e09a2f 100644 --- a/docs/models/outputcodeinterpreterservertoolitem.mdx +++ b/docs/models/outputcodeinterpreterservertoolitem.mdx @@ -23,7 +23,7 @@ let value: OutputCodeInterpreterServerToolItem = { | `exitCode` | *number* | :heavy_minus_sign: | N/A | | | `id` | *string* | :heavy_minus_sign: | N/A | | | `language` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `status` | [models.ToolCallStatus](../models/toolcallstatus) | :heavy_check_mark: | N/A | completed | | `stderr` | *string* | :heavy_minus_sign: | N/A | | | `stdout` | *string* | :heavy_minus_sign: | N/A | | -| `type` | [models.OutputCodeInterpreterServerToolItemType](../models/outputcodeinterpreterservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `type` | [models.OutputCodeInterpreterServerToolItemType](../models/outputcodeinterpreterservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/outputcomputercallitem.mdx b/docs/models/outputcomputercallitem.mdx index 8b85ef07d..25817d3c0 100644 --- a/docs/models/outputcomputercallitem.mdx +++ b/docs/models/outputcomputercallitem.mdx @@ -22,6 +22,6 @@ let value: OutputComputerCallItem = { | `action` | *any* | :heavy_minus_sign: | N/A | | `callId` | *string* | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_minus_sign: | N/A | -| `pendingSafetyChecks` | [models.PendingSafetyCheck](../models/pendingsafetycheck.mdx)[] | :heavy_check_mark: | N/A | -| `status` | [models.OutputComputerCallItemStatus](../models/outputcomputercallitemstatus.mdx) | :heavy_check_mark: | N/A | -| `type` | [models.OutputComputerCallItemType](../models/outputcomputercallitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `pendingSafetyChecks` | [models.PendingSafetyCheck](../models/pendingsafetycheck)[] | :heavy_check_mark: | N/A | +| `status` | [models.OutputComputerCallItemStatus](../models/outputcomputercallitemstatus) | :heavy_check_mark: | N/A | +| `type` | [models.OutputComputerCallItemType](../models/outputcomputercallitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/outputcustomtoolcallitem.mdx b/docs/models/outputcustomtoolcallitem.mdx index 78c7ce9ba..60dd71653 100644 --- a/docs/models/outputcustomtoolcallitem.mdx +++ b/docs/models/outputcustomtoolcallitem.mdx @@ -26,4 +26,4 @@ let value: OutputCustomToolCallItem = { | `input` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_check_mark: | N/A | | `namespace` | *string* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | -| `type` | [models.OutputCustomToolCallItemType](../models/outputcustomtoolcallitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.OutputCustomToolCallItemType](../models/outputcustomtoolcallitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/outputdatetimeitem.mdx b/docs/models/outputdatetimeitem.mdx index 7d8c5bd4f..87bcedcb9 100644 --- a/docs/models/outputdatetimeitem.mdx +++ b/docs/models/outputdatetimeitem.mdx @@ -23,6 +23,6 @@ let value: OutputDatetimeItem = { | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | | `datetime` | *string* | :heavy_check_mark: | ISO 8601 datetime string | | | `id` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `status` | [models.ToolCallStatus](../models/toolcallstatus) | :heavy_check_mark: | N/A | completed | | `timezone` | *string* | :heavy_check_mark: | IANA timezone name | | -| `type` | [models.OutputDatetimeItemType](../models/outputdatetimeitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `type` | [models.OutputDatetimeItemType](../models/outputdatetimeitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/outputfilesearchcallitem.mdx b/docs/models/outputfilesearchcallitem.mdx index 1bea84a57..d913d43b1 100644 --- a/docs/models/outputfilesearchcallitem.mdx +++ b/docs/models/outputfilesearchcallitem.mdx @@ -23,5 +23,5 @@ let value: OutputFileSearchCallItem = { | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | | `id` | *string* | :heavy_check_mark: | N/A | | | `queries` | *string*[] | :heavy_check_mark: | N/A | | -| `status` | [models.WebSearchStatus](../models/websearchstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputFileSearchCallItemType](../models/outputfilesearchcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `status` | [models.WebSearchStatus](../models/websearchstatus) | :heavy_check_mark: | N/A | completed | +| `type` | [models.OutputFileSearchCallItemType](../models/outputfilesearchcallitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/outputfilesearchservertoolitem.mdx b/docs/models/outputfilesearchservertoolitem.mdx index 39c2676cc..108bc8f3b 100644 --- a/docs/models/outputfilesearchservertoolitem.mdx +++ b/docs/models/outputfilesearchservertoolitem.mdx @@ -21,5 +21,5 @@ let value: OutputFileSearchServerToolItem = { | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | | `id` | *string* | :heavy_minus_sign: | N/A | | | `queries` | *string*[] | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputFileSearchServerToolItemType](../models/outputfilesearchservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `status` | [models.ToolCallStatus](../models/toolcallstatus) | :heavy_check_mark: | N/A | completed | +| `type` | [models.OutputFileSearchServerToolItemType](../models/outputfilesearchservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/outputfilesservertoolitem.mdx b/docs/models/outputfilesservertoolitem.mdx index 8a190270f..429c00ea4 100644 --- a/docs/models/outputfilesservertoolitem.mdx +++ b/docs/models/outputfilesservertoolitem.mdx @@ -25,5 +25,5 @@ let value: OutputFilesServerToolItem = { | `id` | *string* | :heavy_minus_sign: | N/A | | | `operation` | *string* | :heavy_minus_sign: | The file operation performed (list, read, write, or edit). | | | `result` | *string* | :heavy_minus_sign: | JSON-serialized result of the file operation. | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputFilesServerToolItemType](../models/outputfilesservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `status` | [models.ToolCallStatus](../models/toolcallstatus) | :heavy_check_mark: | N/A | completed | +| `type` | [models.OutputFilesServerToolItemType](../models/outputfilesservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/outputfunctioncallitem.mdx b/docs/models/outputfunctioncallitem.mdx index 3f2b1eeb0..e8d5767f3 100644 --- a/docs/models/outputfunctioncallitem.mdx +++ b/docs/models/outputfunctioncallitem.mdx @@ -25,4 +25,4 @@ let value: OutputFunctionCallItem = { | `name` | *string* | :heavy_check_mark: | N/A | | `namespace` | *string* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | `status` | *models.OutputFunctionCallItemStatusUnion* | :heavy_minus_sign: | N/A | -| `type` | [models.OutputFunctionCallItemType](../models/outputfunctioncallitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.OutputFunctionCallItemType](../models/outputfunctioncallitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/outputfusionservertoolitem.mdx b/docs/models/outputfusionservertoolitem.mdx index 3000ad39b..5c308d52f 100644 --- a/docs/models/outputfusionservertoolitem.mdx +++ b/docs/models/outputfusionservertoolitem.mdx @@ -19,12 +19,12 @@ let value: OutputFusionServerToolItem = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `analysis` | [models.FusionAnalysisResult](../models/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"
}
]
} | +| `analysis` | [models.FusionAnalysisResult](../models/fusionanalysisresult) | :heavy_minus_sign: | Structured analysis produced by the fusion analyst model. | \{
"blind_spots": [
"No model considered the impact on existing API consumers."
],
"consensus": [
"All panel models agree the request is asking for a concise summary."
],
"contradictions": [
\{
"stances": [
\{
"model": "openai/gpt-5",
"stance": "Favors an incremental rollout."
},
\{
"model": "anthropic/claude-sonnet-4.5",
"stance": "Favors a single coordinated migration."
}
],
"topic": "Recommended approach"
}
],
"partial_coverage": [
\{
"models": [
"openai/gpt-5"
],
"point": "Only one model addressed the rollback strategy."
}
],
"unique_insights": [
\{
"insight": "Highlighted a backwards-compatibility risk the other models missed.",
"model": "anthropic/claude-sonnet-4.5"
}
]
} | | `error` | *string* | :heavy_minus_sign: | Error message when the fusion run did not produce an analysis result. | | -| `failedModels` | [models.FailedModel](../models/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. The fusion result is still usable but was produced from a degraded panel. | | +| `failedModels` | [models.FailedModel](../models/failedmodel)[] | :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. The fusion result is still usable but was produced from a degraded panel. | | | `failureReason` | *string* | :heavy_minus_sign: | Typed failure reason when the fusion run failed. Possible values include: all_panels_failed, insufficient_credits, rate_limited, 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. | | | `id` | *string* | :heavy_minus_sign: | N/A | | -| `responses` | [models.ResponseT](../models/responset.mdx)[] | :heavy_minus_sign: | Analysis models that produced a response in this fusion run, with each model's full panel content. | | -| `sources` | [models.FusionSource](../models/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` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputFusionServerToolItemType](../models/outputfusionservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `responses` | [models.ResponseT](../models/responset)[] | :heavy_minus_sign: | Analysis models that produced a response in this fusion run, with each model's full panel content. | | +| `sources` | [models.FusionSource](../models/fusionsource)[] | :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` | [models.ToolCallStatus](../models/toolcallstatus) | :heavy_check_mark: | N/A | completed | +| `type` | [models.OutputFusionServerToolItemType](../models/outputfusionservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/outputimagegenerationcallitem.mdx b/docs/models/outputimagegenerationcallitem.mdx index fb6f5e8f3..44b97e007 100644 --- a/docs/models/outputimagegenerationcallitem.mdx +++ b/docs/models/outputimagegenerationcallitem.mdx @@ -20,6 +20,6 @@ let value: OutputImageGenerationCallItem = { | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | N/A | | | `result` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ImageGenerationStatus](../models/imagegenerationstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputImageGenerationCallItemType](../models/outputimagegenerationcallitemtype.mdx) | :heavy_check_mark: | N/A | | +| `status` | [models.ImageGenerationStatus](../models/imagegenerationstatus) | :heavy_check_mark: | N/A | completed | +| `type` | [models.OutputImageGenerationCallItemType](../models/outputimagegenerationcallitemtype) | :heavy_check_mark: | N/A | | | `prompt` | *string* | :heavy_minus_sign: | The prompt (possibly rewritten) that the image was generated from. | | \ No newline at end of file diff --git a/docs/models/outputimagegenerationservertoolitem.mdx b/docs/models/outputimagegenerationservertoolitem.mdx index 70161d9f0..a23d9a6f5 100644 --- a/docs/models/outputimagegenerationservertoolitem.mdx +++ b/docs/models/outputimagegenerationservertoolitem.mdx @@ -25,5 +25,5 @@ let value: OutputImageGenerationServerToolItem = { | `prompt` | *string* | :heavy_minus_sign: | The prompt (possibly rewritten) that the image was generated from. | | | `result` | *string* | :heavy_minus_sign: | The generated image as a base64-encoded string or URL, matching OpenAI image_generation_call format | | | `revisedPrompt` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputImageGenerationServerToolItemType](../models/outputimagegenerationservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `status` | [models.ToolCallStatus](../models/toolcallstatus) | :heavy_check_mark: | N/A | completed | +| `type` | [models.OutputImageGenerationServerToolItemType](../models/outputimagegenerationservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/outputitemimagegenerationcall.mdx b/docs/models/outputitemimagegenerationcall.mdx index 3a21ebe1d..1ade32b31 100644 --- a/docs/models/outputitemimagegenerationcall.mdx +++ b/docs/models/outputitemimagegenerationcall.mdx @@ -22,5 +22,5 @@ let value: OutputItemImageGenerationCall = { | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | N/A | | | `result` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ImageGenerationStatus](../models/imagegenerationstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputItemImageGenerationCallType](../models/outputitemimagegenerationcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `status` | [models.ImageGenerationStatus](../models/imagegenerationstatus) | :heavy_check_mark: | N/A | completed | +| `type` | [models.OutputItemImageGenerationCallType](../models/outputitemimagegenerationcalltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/outputmcpservertoolitem.mdx b/docs/models/outputmcpservertoolitem.mdx index 218dc8d2c..9fe8a8bf5 100644 --- a/docs/models/outputmcpservertoolitem.mdx +++ b/docs/models/outputmcpservertoolitem.mdx @@ -21,6 +21,6 @@ let value: OutputMcpServerToolItem = { | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | | `id` | *string* | :heavy_minus_sign: | N/A | | | `serverLabel` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `status` | [models.ToolCallStatus](../models/toolcallstatus) | :heavy_check_mark: | N/A | completed | | `toolName` | *string* | :heavy_minus_sign: | N/A | | -| `type` | [models.OutputMcpServerToolItemType](../models/outputmcpservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `type` | [models.OutputMcpServerToolItemType](../models/outputmcpservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/outputmemoryservertoolitem.mdx b/docs/models/outputmemoryservertoolitem.mdx index 376baf094..d00c63bf6 100644 --- a/docs/models/outputmemoryservertoolitem.mdx +++ b/docs/models/outputmemoryservertoolitem.mdx @@ -19,9 +19,9 @@ let value: OutputMemoryServerToolItem = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `action` | [models.ActionEnum](../models/actionenum.mdx) | :heavy_minus_sign: | N/A | | +| `action` | [models.ActionEnum](../models/actionenum) | :heavy_minus_sign: | N/A | | | `id` | *string* | :heavy_minus_sign: | N/A | | | `key` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputMemoryServerToolItemType](../models/outputmemoryservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | +| `status` | [models.ToolCallStatus](../models/toolcallstatus) | :heavy_check_mark: | N/A | completed | +| `type` | [models.OutputMemoryServerToolItemType](../models/outputmemoryservertoolitemtype) | :heavy_check_mark: | N/A | | | `value` | *any* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/outputmessage.mdx b/docs/models/outputmessage.mdx index 4ab9d5e7c..b03d86749 100644 --- a/docs/models/outputmessage.mdx +++ b/docs/models/outputmessage.mdx @@ -27,6 +27,6 @@ let value: OutputMessage = { | `content` | *models.OutputMessageContent*[] | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | | `phase` | *models.OutputMessagePhaseUnion* | :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` | [models.OutputMessageRole](../models/outputmessagerole.mdx) | :heavy_check_mark: | N/A | +| `role` | [models.OutputMessageRole](../models/outputmessagerole) | :heavy_check_mark: | N/A | | `status` | *models.OutputMessageStatusUnion* | :heavy_minus_sign: | N/A | -| `type` | [models.OutputMessageType](../models/outputmessagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.OutputMessageType](../models/outputmessagetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/outputmessageitem.mdx b/docs/models/outputmessageitem.mdx index a5fb774b4..cdf8d6dfc 100644 --- a/docs/models/outputmessageitem.mdx +++ b/docs/models/outputmessageitem.mdx @@ -29,6 +29,6 @@ let value: OutputMessageItem = { | `content` | *models.OutputMessageItemContent*[] | :heavy_check_mark: | N/A | | `id` | *string* | :heavy_check_mark: | N/A | | `phase` | *models.OutputMessageItemPhaseUnion* | :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` | [models.OutputMessageItemRole](../models/outputmessageitemrole.mdx) | :heavy_check_mark: | N/A | +| `role` | [models.OutputMessageItemRole](../models/outputmessageitemrole) | :heavy_check_mark: | N/A | | `status` | *models.OutputMessageItemStatusUnion* | :heavy_minus_sign: | N/A | | `type` | *"message"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/outputreasoningitem.mdx b/docs/models/outputreasoningitem.mdx index 729c765fa..cccc5d88e 100644 --- a/docs/models/outputreasoningitem.mdx +++ b/docs/models/outputreasoningitem.mdx @@ -25,11 +25,11 @@ let value: OutputReasoningItem = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `content` | [models.ReasoningTextContent](../models/reasoningtextcontent.mdx)[] | :heavy_minus_sign: | N/A | | +| `content` | [models.ReasoningTextContent](../models/reasoningtextcontent)[] | :heavy_minus_sign: | N/A | | | `encryptedContent` | *string* | :heavy_minus_sign: | N/A | | | `id` | *string* | :heavy_check_mark: | N/A | | | `status` | *models.OutputReasoningItemStatusUnion* | :heavy_minus_sign: | N/A | | -| `summary` | [models.ReasoningSummaryText](../models/reasoningsummarytext.mdx)[] | :heavy_check_mark: | N/A | | +| `summary` | [models.ReasoningSummaryText](../models/reasoningsummarytext)[] | :heavy_check_mark: | N/A | | | `type` | *"reasoning"* | :heavy_check_mark: | N/A | | -| `format` | [models.ReasoningFormat](../models/reasoningformat.mdx) | :heavy_minus_sign: | N/A | unknown | +| `format` | [models.ReasoningFormat](../models/reasoningformat) | :heavy_minus_sign: | N/A | unknown | | `signature` | *string* | :heavy_minus_sign: | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | \ No newline at end of file diff --git a/docs/models/outputsearchmodelsservertoolitem.mdx b/docs/models/outputsearchmodelsservertoolitem.mdx index ab3dc4110..cfa3aa01d 100644 --- a/docs/models/outputsearchmodelsservertoolitem.mdx +++ b/docs/models/outputsearchmodelsservertoolitem.mdx @@ -22,5 +22,5 @@ let value: OutputSearchModelsServerToolItem = { | `arguments` | *string* | :heavy_minus_sign: | The JSON arguments submitted to the search tool (e.g. \{"query":"Claude"}) | | | `id` | *string* | :heavy_minus_sign: | N/A | | | `query` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputSearchModelsServerToolItemType](../models/outputsearchmodelsservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `status` | [models.ToolCallStatus](../models/toolcallstatus) | :heavy_check_mark: | N/A | completed | +| `type` | [models.OutputSearchModelsServerToolItemType](../models/outputsearchmodelsservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/outputshellcallitem.mdx b/docs/models/outputshellcallitem.mdx index 6c1d4ad1f..528903903 100644 --- a/docs/models/outputshellcallitem.mdx +++ b/docs/models/outputshellcallitem.mdx @@ -21,8 +21,8 @@ let value: OutputShellCallItem = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `action` | [models.OutputShellCallItemAction](../models/outputshellcallitemaction.mdx) | :heavy_minus_sign: | N/A | | +| `action` | [models.OutputShellCallItemAction](../models/outputshellcallitemaction) | :heavy_minus_sign: | N/A | | | `callId` | *string* | :heavy_check_mark: | N/A | | | `id` | *string* | :heavy_check_mark: | N/A | | -| `status` | [models.ShellCallStatus](../models/shellcallstatus.mdx) | :heavy_check_mark: | Status of a shell call or its output. | completed | +| `status` | [models.ShellCallStatus](../models/shellcallstatus) | :heavy_check_mark: | Status of a shell call or its output. | completed | | `type` | *"shell_call"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/outputshellcalloutputitem.mdx b/docs/models/outputshellcalloutputitem.mdx index 8f42f26a9..8c7c3eed9 100644 --- a/docs/models/outputshellcalloutputitem.mdx +++ b/docs/models/outputshellcalloutputitem.mdx @@ -25,6 +25,6 @@ let value: OutputShellCallOutputItem = { | `callId` | *string* | :heavy_check_mark: | N/A | | | `id` | *string* | :heavy_check_mark: | N/A | | | `maxOutputLength` | *number* | :heavy_minus_sign: | N/A | | -| `output` | [models.OutputShellCallOutputItemOutput](../models/outputshellcalloutputitemoutput.mdx)[] | :heavy_check_mark: | N/A | | -| `status` | [models.ShellCallStatus](../models/shellcallstatus.mdx) | :heavy_check_mark: | Status of a shell call or its output. | completed | +| `output` | [models.OutputShellCallOutputItemOutput](../models/outputshellcalloutputitemoutput)[] | :heavy_check_mark: | N/A | | +| `status` | [models.ShellCallStatus](../models/shellcallstatus) | :heavy_check_mark: | Status of a shell call or its output. | completed | | `type` | *"shell_call_output"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/outputsubagentservertoolitem.mdx b/docs/models/outputsubagentservertoolitem.mdx index 82af85648..ac4d94b6b 100644 --- a/docs/models/outputsubagentservertoolitem.mdx +++ b/docs/models/outputsubagentservertoolitem.mdx @@ -25,7 +25,7 @@ let value: OutputSubagentServerToolItem = { | `model` | *string* | :heavy_minus_sign: | Slug of the worker model that executed the task. | | | `name` | *string* | :heavy_minus_sign: | Configured name of the subagent that executed the task (the `name` on its tool entry). Present only for named subagents; omitted for an unnamed (default) subagent. | summarizer | | `outcome` | *string* | :heavy_minus_sign: | The worker model's result (the outcome text returned to the delegating model). | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `status` | [models.ToolCallStatus](../models/toolcallstatus) | :heavy_check_mark: | N/A | completed | | `taskDescription` | *string* | :heavy_minus_sign: | The task description the delegating model sent to the worker. | | | `taskName` | *string* | :heavy_minus_sign: | The short task identifier the delegating model supplied. | | -| `type` | [models.OutputSubagentServerToolItemType](../models/outputsubagentservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `type` | [models.OutputSubagentServerToolItemType](../models/outputsubagentservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/outputtexteditorservertoolitem.mdx b/docs/models/outputtexteditorservertoolitem.mdx index 9dc22d29e..8c9424ba1 100644 --- a/docs/models/outputtexteditorservertoolitem.mdx +++ b/docs/models/outputtexteditorservertoolitem.mdx @@ -19,8 +19,8 @@ let value: OutputTextEditorServerToolItem = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `command` | [models.Command](../models/command.mdx) | :heavy_minus_sign: | N/A | | +| `command` | [models.Command](../models/command) | :heavy_minus_sign: | N/A | | | `filePath` | *string* | :heavy_minus_sign: | N/A | | | `id` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputTextEditorServerToolItemType](../models/outputtexteditorservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `status` | [models.ToolCallStatus](../models/toolcallstatus) | :heavy_check_mark: | N/A | completed | +| `type` | [models.OutputTextEditorServerToolItemType](../models/outputtexteditorservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/outputtoolsearchservertoolitem.mdx b/docs/models/outputtoolsearchservertoolitem.mdx index 0522241c2..c524ec5ab 100644 --- a/docs/models/outputtoolsearchservertoolitem.mdx +++ b/docs/models/outputtoolsearchservertoolitem.mdx @@ -21,5 +21,5 @@ let value: OutputToolSearchServerToolItem = { | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | | `id` | *string* | :heavy_minus_sign: | N/A | | | `query` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputToolSearchServerToolItemType](../models/outputtoolsearchservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `status` | [models.ToolCallStatus](../models/toolcallstatus) | :heavy_check_mark: | N/A | completed | +| `type` | [models.OutputToolSearchServerToolItemType](../models/outputtoolsearchservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/outputwebfetchservertoolitem.mdx b/docs/models/outputwebfetchservertoolitem.mdx index 19d8cbd24..af14d867e 100644 --- a/docs/models/outputwebfetchservertoolitem.mdx +++ b/docs/models/outputwebfetchservertoolitem.mdx @@ -23,7 +23,7 @@ let value: OutputWebFetchServerToolItem = { | `error` | *string* | :heavy_minus_sign: | The error message if the fetch failed. | | | `httpStatus` | *number* | :heavy_minus_sign: | The HTTP status code returned by the upstream URL fetch. | | | `id` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `status` | [models.ToolCallStatus](../models/toolcallstatus) | :heavy_check_mark: | N/A | completed | | `title` | *string* | :heavy_minus_sign: | N/A | | -| `type` | [models.OutputWebFetchServerToolItemType](../models/outputwebfetchservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | +| `type` | [models.OutputWebFetchServerToolItemType](../models/outputwebfetchservertoolitemtype) | :heavy_check_mark: | N/A | | | `url` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/outputwebsearchcallitem.mdx b/docs/models/outputwebsearchcallitem.mdx index 4ad061009..bc6ae6ff9 100644 --- a/docs/models/outputwebsearchcallitem.mdx +++ b/docs/models/outputwebsearchcallitem.mdx @@ -20,5 +20,5 @@ let value: OutputWebSearchCallItem = { | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | | `action` | *models.Action* | :heavy_minus_sign: | N/A | | | `id` | *string* | :heavy_check_mark: | N/A | | -| `status` | [models.WebSearchStatus](../models/websearchstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.TypeWebSearchCall](../models/typewebsearchcall.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `status` | [models.WebSearchStatus](../models/websearchstatus) | :heavy_check_mark: | N/A | completed | +| `type` | [models.TypeWebSearchCall](../models/typewebsearchcall) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/outputwebsearchcallitemactionsearch.mdx b/docs/models/outputwebsearchcallitemactionsearch.mdx index ed08a139a..f4a5b3758 100644 --- a/docs/models/outputwebsearchcallitemactionsearch.mdx +++ b/docs/models/outputwebsearchcallitemactionsearch.mdx @@ -19,5 +19,5 @@ let value: OutputWebSearchCallItemActionSearch = { | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | | `queries` | *string*[] | :heavy_minus_sign: | N/A | | `query` | *string* | :heavy_check_mark: | N/A | -| `sources` | [models.WebSearchSource](../models/websearchsource.mdx)[] | :heavy_minus_sign: | N/A | +| `sources` | [models.WebSearchSource](../models/websearchsource)[] | :heavy_minus_sign: | N/A | | `type` | *"search"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/outputwebsearchservertoolitem.mdx b/docs/models/outputwebsearchservertoolitem.mdx index 1d9d2aa3d..d80ab6da6 100644 --- a/docs/models/outputwebsearchservertoolitem.mdx +++ b/docs/models/outputwebsearchservertoolitem.mdx @@ -19,7 +19,7 @@ let value: OutputWebSearchServerToolItem = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `action` | [models.OutputWebSearchServerToolItemAction](../models/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. | | +| `action` | [models.OutputWebSearchServerToolItemAction](../models/outputwebsearchservertoolitemaction) | :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. | | | `id` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputWebSearchServerToolItemTypeOpenrouterWebSearch](../models/outputwebsearchservertoolitemtypeopenrouterwebsearch.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `status` | [models.ToolCallStatus](../models/toolcallstatus) | :heavy_check_mark: | N/A | completed | +| `type` | [models.OutputWebSearchServerToolItemTypeOpenrouterWebSearch](../models/outputwebsearchservertoolitemtypeopenrouterwebsearch) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/outputwebsearchservertoolitemaction.mdx b/docs/models/outputwebsearchservertoolitemaction.mdx index 9cbee2778..454d894bd 100644 --- a/docs/models/outputwebsearchservertoolitemaction.mdx +++ b/docs/models/outputwebsearchservertoolitemaction.mdx @@ -20,5 +20,5 @@ let value: OutputWebSearchServerToolItemAction = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | | `query` | *string* | :heavy_check_mark: | N/A | -| `sources` | [models.OutputWebSearchServerToolItemSource](../models/outputwebsearchservertoolitemsource.mdx)[] | :heavy_minus_sign: | N/A | -| `type` | [models.OutputWebSearchServerToolItemTypeSearch](../models/outputwebsearchservertoolitemtypesearch.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `sources` | [models.OutputWebSearchServerToolItemSource](../models/outputwebsearchservertoolitemsource)[] | :heavy_minus_sign: | N/A | +| `type` | [models.OutputWebSearchServerToolItemTypeSearch](../models/outputwebsearchservertoolitemtypesearch) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/outputwebsearchservertoolitemsource.mdx b/docs/models/outputwebsearchservertoolitemsource.mdx index cb965d4cd..3e38b1e86 100644 --- a/docs/models/outputwebsearchservertoolitemsource.mdx +++ b/docs/models/outputwebsearchservertoolitemsource.mdx @@ -17,5 +17,5 @@ let value: OutputWebSearchServerToolItemSource = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `type` | [models.OutputWebSearchServerToolItemTypeURL](../models/outputwebsearchservertoolitemtypeurl.mdx) | :heavy_check_mark: | N/A | +| `type` | [models.OutputWebSearchServerToolItemTypeURL](../models/outputwebsearchservertoolitemtypeurl) | :heavy_check_mark: | N/A | | `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/paretorouterplugin.mdx b/docs/models/paretorouterplugin.mdx index 187b6db90..dce4beeb0 100644 --- a/docs/models/paretorouterplugin.mdx +++ b/docs/models/paretorouterplugin.mdx @@ -20,4 +20,4 @@ let value: ParetoRouterPlugin = { | `id` | *"pareto-router"* | :heavy_check_mark: | N/A | | | `maxPrice` | *number* | :heavy_minus_sign: | Maximum input price in USD per million tokens. When set, quality-tier selection (min_coding_score) is bypassed: the router computes the Pareto frontier over the top coding models and routes to the best-scoring frontier model priced at or below this cap, falling back through cheaper frontier models, then non-frontier models. Enforced against the price source given by price_source. Returns 404 when no candidate satisfies the cap. | 5 | | `minCodingScore` | *number* | :heavy_minus_sign: | Minimum coding quality score between 0 and 1. Maps to internal quality tiers: >= 0.66 → high (top coding models), >= 0.33 → medium (strong modern flagships), < 0.33 → low (capable coders above the median). Omit to default to the highest tier (equivalent to >= 0.66). Not used when max_price is set (price-based selection takes over). | 0.8 | -| `priceSource` | [models.PriceSource](../models/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 +| `priceSource` | [models.PriceSource](../models/pricesource) | :heavy_minus_sign: | Price source for the Pareto frontier cost axis and for enforcing max_price. "prompt" uses catalog list price (endpoint.pricing.prompt). "weighted_avg" uses traffic-weighted effective input price from ClickHouse, falling back to prompt price for models without traffic data. Defaults to "prompt". | | \ No newline at end of file diff --git a/docs/models/pipelinestage.mdx b/docs/models/pipelinestage.mdx index a445758be..6563a105f 100644 --- a/docs/models/pipelinestage.mdx +++ b/docs/models/pipelinestage.mdx @@ -23,4 +23,4 @@ let value: PipelineStage = { | `guardrailScope` | *string* | :heavy_minus_sign: | N/A | | | `name` | *string* | :heavy_check_mark: | N/A | | | `summary` | *string* | :heavy_minus_sign: | N/A | | -| `type` | [models.PipelineStageType](../models/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 +| `type` | [models.PipelineStageType](../models/pipelinestagetype) | :heavy_check_mark: | Categorical kind of a pipeline stage. Multiple plugins can share a type (e.g. all guardrail-level plugins emit `guardrail`); the `name` field disambiguates which plugin emitted it. | guardrail | \ No newline at end of file diff --git a/docs/models/prediction.mdx b/docs/models/prediction.mdx index e88206524..f5184fc2e 100644 --- a/docs/models/prediction.mdx +++ b/docs/models/prediction.mdx @@ -20,4 +20,4 @@ let value: Prediction = { | Field | Type | Required | Description | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | | `content` | *models.PredictionContent* | :heavy_check_mark: | N/A | -| `type` | [models.PredictionType](../models/predictiontype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.PredictionType](../models/predictiontype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/predictioncontenttext.mdx b/docs/models/predictioncontenttext.mdx index e8f4063eb..e2b687baf 100644 --- a/docs/models/predictioncontenttext.mdx +++ b/docs/models/predictioncontenttext.mdx @@ -20,4 +20,4 @@ let value: PredictionContentText = { | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | | `text` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.PredictionContentTextType](../models/predictioncontenttexttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.PredictionContentTextType](../models/predictioncontenttexttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/preset.mdx b/docs/models/preset.mdx index 2f2c0a080..21e7f549b 100644 --- a/docs/models/preset.mdx +++ b/docs/models/preset.mdx @@ -35,7 +35,7 @@ let value: Preset = { | `id` | *string* | :heavy_check_mark: | N/A | | | `name` | *string* | :heavy_check_mark: | N/A | | | `slug` | *string* | :heavy_check_mark: | N/A | | -| `status` | [models.PresetStatus](../models/presetstatus.mdx) | :heavy_check_mark: | The status of a preset. | active | +| `status` | [models.PresetStatus](../models/presetstatus) | :heavy_check_mark: | The status of a preset. | active | | `statusUpdatedAt` | *string* | :heavy_check_mark: | N/A | | | `updatedAt` | *string* | :heavy_check_mark: | N/A | | | `workspaceId` | *string* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/presetwithdesignatedversion.mdx b/docs/models/presetwithdesignatedversion.mdx index 2e284a7ad..e4a97704f 100644 --- a/docs/models/presetwithdesignatedversion.mdx +++ b/docs/models/presetwithdesignatedversion.mdx @@ -48,8 +48,8 @@ let value: PresetWithDesignatedVersion = { | `id` | *string* | :heavy_check_mark: | N/A | | | `name` | *string* | :heavy_check_mark: | N/A | | | `slug` | *string* | :heavy_check_mark: | N/A | | -| `status` | [models.PresetStatus](../models/presetstatus.mdx) | :heavy_check_mark: | The status of a preset. | active | +| `status` | [models.PresetStatus](../models/presetstatus) | :heavy_check_mark: | The status of a preset. | active | | `statusUpdatedAt` | *string* | :heavy_check_mark: | N/A | | | `updatedAt` | *string* | :heavy_check_mark: | N/A | | | `workspaceId` | *string* | :heavy_check_mark: | N/A | | -| `designatedVersion` | [models.PresetDesignatedVersion](../models/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 +| `designatedVersion` | [models.PresetDesignatedVersion](../models/presetdesignatedversion) | :heavy_check_mark: | A specific version of a preset, containing config and optional system prompt. | \{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
} | \ No newline at end of file diff --git a/docs/models/preview20250311websearchservertool.mdx b/docs/models/preview20250311websearchservertool.mdx index 2f46f449e..de556d506 100644 --- a/docs/models/preview20250311websearchservertool.mdx +++ b/docs/models/preview20250311websearchservertool.mdx @@ -18,10 +18,10 @@ let value: Preview20250311WebSearchServerTool = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `engine` | [models.WebSearchEngineEnum](../models/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` | [models.WebSearchDomainFilter](../models/websearchdomainfilter.mdx) | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | +| `engine` | [models.WebSearchEngineEnum](../models/websearchengineenum) | :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` | [models.WebSearchDomainFilter](../models/websearchdomainfilter) | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | | `maxResults` | *number* | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | | `maxUses` | *number* | :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 | -| `searchContextSize` | [models.SearchContextSizeEnum](../models/searchcontextsizeenum.mdx) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `type` | [models.Preview20250311WebSearchServerToolType](../models/preview20250311websearchservertooltype.mdx) | :heavy_check_mark: | N/A | | -| `userLocation` | [models.PreviewWebSearchUserLocation](../models/previewwebsearchuserlocation.mdx) | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file +| `searchContextSize` | [models.SearchContextSizeEnum](../models/searchcontextsizeenum) | :heavy_minus_sign: | Size of the search context for web search tools | medium | +| `type` | [models.Preview20250311WebSearchServerToolType](../models/preview20250311websearchservertooltype) | :heavy_check_mark: | N/A | | +| `userLocation` | [models.PreviewWebSearchUserLocation](../models/previewwebsearchuserlocation) | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file diff --git a/docs/models/previewwebsearchservertool.mdx b/docs/models/previewwebsearchservertool.mdx index b0b26bbc5..5cc5e7b2d 100644 --- a/docs/models/previewwebsearchservertool.mdx +++ b/docs/models/previewwebsearchservertool.mdx @@ -18,10 +18,10 @@ let value: PreviewWebSearchServerTool = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `engine` | [models.WebSearchEngineEnum](../models/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` | [models.WebSearchDomainFilter](../models/websearchdomainfilter.mdx) | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | +| `engine` | [models.WebSearchEngineEnum](../models/websearchengineenum) | :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` | [models.WebSearchDomainFilter](../models/websearchdomainfilter) | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | | `maxResults` | *number* | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | | `maxUses` | *number* | :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 | -| `searchContextSize` | [models.SearchContextSizeEnum](../models/searchcontextsizeenum.mdx) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `type` | [models.PreviewWebSearchServerToolType](../models/previewwebsearchservertooltype.mdx) | :heavy_check_mark: | N/A | | -| `userLocation` | [models.PreviewWebSearchUserLocation](../models/previewwebsearchuserlocation.mdx) | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file +| `searchContextSize` | [models.SearchContextSizeEnum](../models/searchcontextsizeenum) | :heavy_minus_sign: | Size of the search context for web search tools | medium | +| `type` | [models.PreviewWebSearchServerToolType](../models/previewwebsearchservertooltype) | :heavy_check_mark: | N/A | | +| `userLocation` | [models.PreviewWebSearchUserLocation](../models/previewwebsearchuserlocation) | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file diff --git a/docs/models/previewwebsearchuserlocation.mdx b/docs/models/previewwebsearchuserlocation.mdx index 6c0c7eeb6..ae1016b7a 100644 --- a/docs/models/previewwebsearchuserlocation.mdx +++ b/docs/models/previewwebsearchuserlocation.mdx @@ -20,4 +20,4 @@ let value: PreviewWebSearchUserLocation = { | `country` | *string* | :heavy_minus_sign: | N/A | | `region` | *string* | :heavy_minus_sign: | N/A | | `timezone` | *string* | :heavy_minus_sign: | N/A | -| `type` | [models.PreviewWebSearchUserLocationType](../models/previewwebsearchuserlocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.PreviewWebSearchUserLocationType](../models/previewwebsearchuserlocationtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/pricing.mdx b/docs/models/pricing.mdx index 8b3f039a3..ac38024eb 100644 --- a/docs/models/pricing.mdx +++ b/docs/models/pricing.mdx @@ -29,7 +29,7 @@ let value: Pricing = { | `inputCacheWrite` | *string* | :heavy_minus_sign: | Price per cache-write token, in USD per token. For providers with multiple cache TTLs (e.g. Anthropic), this is the default (5-minute) cache-write rate. | | `inputCacheWrite1h` | *string* | :heavy_minus_sign: | Price per 1-hour cache-write token, in USD per token. Only present for providers that price an extended (1-hour) cache TTL separately, such as Anthropic. | | `internalReasoning` | *string* | :heavy_minus_sign: | Price in USD per internal reasoning token | -| `overrides` | [models.PricingOverride](../models/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. | +| `overrides` | [models.PricingOverride](../models/pricingoverride)[] | :heavy_minus_sign: | Conditional overrides of the base pricing (e.g. long-context or time-based pricing). An entry applies when all of its condition fields (e.g. min_prompt_tokens, or the utc_start/utc_end time window) match the request; among applicable entries, later entries win per key; price keys absent from an entry inherit the base price. The top-level pricing keys always reflect the price that applies under default conditions. | | `prompt` | *string* | :heavy_check_mark: | Price in USD per token for prompt (input) processing | | `request` | *string* | :heavy_minus_sign: | Price in USD per request | | `webSearch` | *string* | :heavy_minus_sign: | Price in USD per web search | \ No newline at end of file diff --git a/docs/models/promptcachebreakpoint.mdx b/docs/models/promptcachebreakpoint.mdx index 371a22a55..129e1965d 100644 --- a/docs/models/promptcachebreakpoint.mdx +++ b/docs/models/promptcachebreakpoint.mdx @@ -18,4 +18,4 @@ let value: PromptCacheBreakpoint = { | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `mode` | [models.PromptCacheBreakpointMode](../models/promptcachebreakpointmode.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `mode` | [models.PromptCacheBreakpointMode](../models/promptcachebreakpointmode) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/promptcacheoptions.mdx b/docs/models/promptcacheoptions.mdx index 6eeef981b..e5891ddd8 100644 --- a/docs/models/promptcacheoptions.mdx +++ b/docs/models/promptcacheoptions.mdx @@ -18,5 +18,5 @@ let value: PromptCacheOptions = { | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `mode` | [models.PromptCacheOptionsMode](../models/promptcacheoptionsmode.mdx) | :heavy_check_mark: | N/A | +| `mode` | [models.PromptCacheOptionsMode](../models/promptcacheoptionsmode) | :heavy_check_mark: | N/A | | `ttl` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/providerpreferences.mdx b/docs/models/providerpreferences.mdx index 98ed78b6c..9e44d3e16 100644 --- a/docs/models/providerpreferences.mdx +++ b/docs/models/providerpreferences.mdx @@ -17,15 +17,15 @@ let value: ProviderPreferences = {}; | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `allowFallbacks` | *boolean* | :heavy_minus_sign: | Whether to allow backup providers to serve requests
- true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.
- false: use only the primary/custom provider, and return the upstream error if it's unavailable.
| | -| `dataCollection` | [models.DataCollection](../models/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 | +| `dataCollection` | [models.DataCollection](../models/datacollection) | :heavy_minus_sign: | Data collection setting. If no available model provider meets the requirement, your request will return an error.
- allow: (default) allow providers which store user data non-transiently and may train on it

- deny: use only providers which do not collect user data. | allow | | `enforceDistillableText` | *boolean* | :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` | *models.ProviderPreferencesIgnore*[] | :heavy_minus_sign: | List of provider slugs to ignore. If provided, this list is merged with your account-wide ignored provider settings for this request. | [
"openai",
"anthropic"
] | -| `maxPrice` | [models.MaxPrice](../models/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. | | +| `maxPrice` | [models.MaxPrice](../models/maxprice) | :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` | *models.ProviderPreferencesOnly*[] | :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"
] | | `order` | *models.ProviderPreferencesOrder*[] | :heavy_minus_sign: | An ordered list of provider slugs. The router will attempt to use the first provider in the subset of this list that supports your requested model, and fall back to the next if it is unavailable. If no providers are available, the request will fail with an error message. | [
"openai",
"anthropic"
] | | `preferredMaxLatency` | *models.PreferredMaxLatency* | :heavy_minus_sign: | Preferred maximum latency (in seconds). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints above the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold. | 5 | | `preferredMinThroughput` | *models.PreferredMinThroughput* | :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` | [models.Quantization](../models/quantization.mdx)[] | :heavy_minus_sign: | A list of quantization levels to filter the provider by. | | +| `quantizations` | [models.Quantization](../models/quantization)[] | :heavy_minus_sign: | A list of quantization levels to filter the provider by. | | | `requireParameters` | *boolean* | :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` | *models.ProviderPreferencesSort* | :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` | *boolean* | :heavy_minus_sign: | Whether to restrict routing to only ZDR (Zero Data Retention) endpoints. When true, only endpoints that do not retain prompts will be used. | true | \ No newline at end of file diff --git a/docs/models/providerresponse.mdx b/docs/models/providerresponse.mdx index 777e899e3..149be4c8d 100644 --- a/docs/models/providerresponse.mdx +++ b/docs/models/providerresponse.mdx @@ -23,6 +23,6 @@ let value: ProviderResponse = { | `isByok` | *boolean* | :heavy_minus_sign: | Whether the request used a bring-your-own-key | false | | `latency` | *number* | :heavy_minus_sign: | Response latency in milliseconds | 1200 | | `modelPermaslug` | *string* | :heavy_minus_sign: | Canonical model slug | openai/gpt-4 | -| `providerName` | [models.ProviderResponseProviderName](../models/providerresponseprovidername.mdx) | :heavy_minus_sign: | Name of the provider | OpenAI | -| `routedServiceTier` | [models.RoutedServiceTier](../models/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 | +| `providerName` | [models.ProviderResponseProviderName](../models/providerresponseprovidername) | :heavy_minus_sign: | Name of the provider | OpenAI | +| `routedServiceTier` | [models.RoutedServiceTier](../models/routedservicetier) | :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` | *number* | :heavy_check_mark: | HTTP status code from the provider | 200 | \ No newline at end of file diff --git a/docs/models/providersortconfig.mdx b/docs/models/providersortconfig.mdx index a45a98ba7..869c8746b 100644 --- a/docs/models/providersortconfig.mdx +++ b/docs/models/providersortconfig.mdx @@ -16,5 +16,5 @@ let value: ProviderSortConfig = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `by` | [models.By](../models/by.mdx) | :heavy_minus_sign: | The provider sorting strategy (price, throughput, latency) | price | -| `partition` | [models.Partition](../models/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` | [models.By](../models/by) | :heavy_minus_sign: | The provider sorting strategy (price, throughput, latency) | price | +| `partition` | [models.Partition](../models/partition) | :heavy_minus_sign: | Partitioning strategy for sorting: "model" (default) groups endpoints by model before sorting (fallback models remain fallbacks), "none" sorts all endpoints together regardless of model. | model | \ No newline at end of file diff --git a/docs/models/publicendpoint.mdx b/docs/models/publicendpoint.mdx index a61ffa370..d25b75e02 100644 --- a/docs/models/publicendpoint.mdx +++ b/docs/models/publicendpoint.mdx @@ -52,20 +52,20 @@ let value: PublicEndpoint = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `contextLength` | *number* | :heavy_check_mark: | N/A | | -| `latencyLast30m` | [models.PercentileStats](../models/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
} | +| `latencyLast30m` | [models.PercentileStats](../models/percentilestats) | :heavy_check_mark: | Latency percentiles in milliseconds over the last 30 minutes. Latency measures time to first token. Only visible when authenticated with an API key or cookie; returns null for unauthenticated requests. | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | | `maxCompletionTokens` | *number* | :heavy_check_mark: | N/A | | | `maxPromptTokens` | *number* | :heavy_check_mark: | N/A | | | `modelId` | *string* | :heavy_check_mark: | The unique identifier for the model (permaslug) | openai/gpt-4 | | `modelName` | *string* | :heavy_check_mark: | N/A | | | `name` | *string* | :heavy_check_mark: | N/A | | -| `pricing` | [models.Pricing](../models/pricing.mdx) | :heavy_check_mark: | N/A | | -| `providerName` | [models.ProviderName](../models/providername.mdx) | :heavy_check_mark: | N/A | OpenAI | -| `quantization` | [models.Quantization](../models/quantization.mdx) | :heavy_check_mark: | N/A | fp16 | -| `status` | [models.EndpointStatus](../models/endpointstatus.mdx) | :heavy_minus_sign: | N/A | 0 | -| `supportedParameters` | [models.Parameter](../models/parameter.mdx)[] | :heavy_check_mark: | N/A | | +| `pricing` | [models.Pricing](../models/pricing) | :heavy_check_mark: | N/A | | +| `providerName` | [models.ProviderName](../models/providername) | :heavy_check_mark: | N/A | OpenAI | +| `quantization` | [models.Quantization](../models/quantization) | :heavy_check_mark: | N/A | fp16 | +| `status` | [models.EndpointStatus](../models/endpointstatus) | :heavy_minus_sign: | N/A | 0 | +| `supportedParameters` | [models.Parameter](../models/parameter)[] | :heavy_check_mark: | N/A | | | `supportsImplicitCaching` | *boolean* | :heavy_check_mark: | N/A | | | `tag` | *string* | :heavy_check_mark: | N/A | | -| `throughputLast30m` | [models.PercentileStats](../models/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `throughputLast30m` | [models.PercentileStats](../models/percentilestats) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | | `uptimeLast1d` | *number* | :heavy_check_mark: | Uptime percentage over the last 1 day, calculated as successful requests / (successful + error requests) * 100. Rate-limited requests are excluded. Returns null if insufficient data. | | | `uptimeLast30m` | *number* | :heavy_check_mark: | N/A | | | `uptimeLast5m` | *number* | :heavy_check_mark: | Uptime percentage over the last 5 minutes, calculated as successful requests / (successful + error requests) * 100. Rate-limited requests are excluded. Returns null if insufficient data. | | \ No newline at end of file diff --git a/docs/models/publicpricing.mdx b/docs/models/publicpricing.mdx index b886478f5..8665a655c 100644 --- a/docs/models/publicpricing.mdx +++ b/docs/models/publicpricing.mdx @@ -31,7 +31,7 @@ let value: PublicPricing = { | `inputCacheWrite` | *string* | :heavy_minus_sign: | Price per cache-write token, in USD per token. For providers with multiple cache TTLs (e.g. Anthropic), this is the default (5-minute) cache-write rate. | | `inputCacheWrite1h` | *string* | :heavy_minus_sign: | Price per 1-hour cache-write token, in USD per token. Only present for providers that price an extended (1-hour) cache TTL separately, such as Anthropic. | | `internalReasoning` | *string* | :heavy_minus_sign: | Price in USD per internal reasoning token | -| `overrides` | [models.PricingOverride](../models/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. | +| `overrides` | [models.PricingOverride](../models/pricingoverride)[] | :heavy_minus_sign: | Conditional overrides of the base pricing (e.g. long-context or time-based pricing). An entry applies when all of its condition fields (e.g. min_prompt_tokens, or the utc_start/utc_end time window) match the request; among applicable entries, later entries win per key; price keys absent from an entry inherit the base price. The top-level pricing keys always reflect the price that applies under default conditions. | | `prompt` | *string* | :heavy_check_mark: | Price in USD per token for prompt (input) processing | | `request` | *string* | :heavy_minus_sign: | Price in USD per request | | `webSearch` | *string* | :heavy_minus_sign: | Price in USD per web search | \ No newline at end of file diff --git a/docs/models/rankingoptions.mdx b/docs/models/rankingoptions.mdx index cd1104f29..feb8375bc 100644 --- a/docs/models/rankingoptions.mdx +++ b/docs/models/rankingoptions.mdx @@ -14,5 +14,5 @@ let value: RankingOptions = {}; | Field | Type | Required | Description | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `ranker` | [models.Ranker](../models/ranker.mdx) | :heavy_minus_sign: | N/A | +| `ranker` | [models.Ranker](../models/ranker) | :heavy_minus_sign: | N/A | | `scoreThreshold` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/rankingsdailymeta.mdx b/docs/models/rankingsdailymeta.mdx index c430cdcde..af5873de4 100644 --- a/docs/models/rankingsdailymeta.mdx +++ b/docs/models/rankingsdailymeta.mdx @@ -22,4 +22,4 @@ let value: RankingsDailyMeta = { | `asOf` | *string* | :heavy_check_mark: | ISO-8601 timestamp of when the response was generated. Reflects data-freshness because the underlying materialized view continuously ingests upstream events. | 2026-05-12T02:00:00Z | | `endDate` | *string* | :heavy_check_mark: | Resolved end of the date window (UTC, inclusive). | 2026-05-11 | | `startDate` | *string* | :heavy_check_mark: | Resolved start of the date window (UTC, inclusive). | 2026-04-12 | -| `version` | [models.RankingsDailyMetaVersion](../models/rankingsdailymetaversion.mdx) | :heavy_check_mark: | Dataset version. Field names and grain are stable for the life of `v1`. | | \ No newline at end of file +| `version` | [models.RankingsDailyMetaVersion](../models/rankingsdailymetaversion) | :heavy_check_mark: | Dataset version. Field names and grain are stable for the life of `v1`. | | \ No newline at end of file diff --git a/docs/models/rankingsdailyresponse.mdx b/docs/models/rankingsdailyresponse.mdx index a67edaa3c..016f3dbf9 100644 --- a/docs/models/rankingsdailyresponse.mdx +++ b/docs/models/rankingsdailyresponse.mdx @@ -33,5 +33,5 @@ let value: RankingsDailyResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.RankingsDailyItem](../models/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` | [models.RankingsDailyMeta](../models/rankingsdailymeta.mdx) | :heavy_check_mark: | N/A | \{
"as_of": "2026-05-12T02:00:00Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
} | \ No newline at end of file +| `data` | [models.RankingsDailyItem](../models/rankingsdailyitem)[] | :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` | [models.RankingsDailyMeta](../models/rankingsdailymeta) | :heavy_check_mark: | N/A | \{
"as_of": "2026-05-12T02:00:00Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
} | \ No newline at end of file diff --git a/docs/models/reasoningconfig.mdx b/docs/models/reasoningconfig.mdx index f744f6a0d..fb37b6a47 100644 --- a/docs/models/reasoningconfig.mdx +++ b/docs/models/reasoningconfig.mdx @@ -14,9 +14,9 @@ let value: ReasoningConfig = {}; | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `context` | [models.ReasoningContext](../models/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` | [models.ReasoningEffort](../models/reasoningeffort.mdx) | :heavy_minus_sign: | N/A | medium | -| `mode` | [models.ReasoningMode](../models/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` | [models.ReasoningSummaryVerbosity](../models/reasoningsummaryverbosity.mdx) | :heavy_minus_sign: | N/A | auto | +| `context` | [models.ReasoningContext](../models/reasoningcontext) | :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` | [models.ReasoningEffort](../models/reasoningeffort) | :heavy_minus_sign: | N/A | medium | +| `mode` | [models.ReasoningMode](../models/reasoningmode) | :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` | [models.ReasoningSummaryVerbosity](../models/reasoningsummaryverbosity) | :heavy_minus_sign: | N/A | auto | | `enabled` | *boolean* | :heavy_minus_sign: | N/A | | | `maxTokens` | *number* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/reasoningdetailencrypted.mdx b/docs/models/reasoningdetailencrypted.mdx index 572ab1504..eb2718223 100644 --- a/docs/models/reasoningdetailencrypted.mdx +++ b/docs/models/reasoningdetailencrypted.mdx @@ -20,7 +20,7 @@ let value: ReasoningDetailEncrypted = { | Field | Type | Required | Description | Example | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | | `data` | *string* | :heavy_check_mark: | N/A | | -| `format` | [models.ReasoningFormat](../models/reasoningformat.mdx) | :heavy_minus_sign: | N/A | unknown | +| `format` | [models.ReasoningFormat](../models/reasoningformat) | :heavy_minus_sign: | N/A | unknown | | `id` | *string* | :heavy_minus_sign: | N/A | | | `index` | *number* | :heavy_minus_sign: | N/A | | | `type` | *"reasoning.encrypted"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/reasoningdetailservertoolcall.mdx b/docs/models/reasoningdetailservertoolcall.mdx index 9760743b7..8ca244941 100644 --- a/docs/models/reasoningdetailservertoolcall.mdx +++ b/docs/models/reasoningdetailservertoolcall.mdx @@ -22,7 +22,7 @@ let value: ReasoningDetailServerToolCall = { | Field | Type | Required | Description | Example | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | | `arguments` | *string* | :heavy_check_mark: | N/A | | -| `format` | [models.ReasoningFormat](../models/reasoningformat.mdx) | :heavy_minus_sign: | N/A | unknown | +| `format` | [models.ReasoningFormat](../models/reasoningformat) | :heavy_minus_sign: | N/A | unknown | | `id` | *string* | :heavy_minus_sign: | N/A | | | `index` | *number* | :heavy_minus_sign: | N/A | | | `result` | *string* | :heavy_check_mark: | N/A | | diff --git a/docs/models/reasoningdetailsummary.mdx b/docs/models/reasoningdetailsummary.mdx index 226874342..69a3f806a 100644 --- a/docs/models/reasoningdetailsummary.mdx +++ b/docs/models/reasoningdetailsummary.mdx @@ -20,7 +20,7 @@ let value: ReasoningDetailSummary = { | Field | Type | Required | Description | Example | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `format` | [models.ReasoningFormat](../models/reasoningformat.mdx) | :heavy_minus_sign: | N/A | unknown | +| `format` | [models.ReasoningFormat](../models/reasoningformat) | :heavy_minus_sign: | N/A | unknown | | `id` | *string* | :heavy_minus_sign: | N/A | | | `index` | *number* | :heavy_minus_sign: | N/A | | | `summary` | *string* | :heavy_check_mark: | N/A | | diff --git a/docs/models/reasoningdetailtext.mdx b/docs/models/reasoningdetailtext.mdx index e69e16d29..05debba43 100644 --- a/docs/models/reasoningdetailtext.mdx +++ b/docs/models/reasoningdetailtext.mdx @@ -18,7 +18,7 @@ let value: ReasoningDetailText = { | Field | Type | Required | Description | Example | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `format` | [models.ReasoningFormat](../models/reasoningformat.mdx) | :heavy_minus_sign: | N/A | unknown | +| `format` | [models.ReasoningFormat](../models/reasoningformat) | :heavy_minus_sign: | N/A | unknown | | `id` | *string* | :heavy_minus_sign: | N/A | | | `index` | *number* | :heavy_minus_sign: | N/A | | | `signature` | *string* | :heavy_minus_sign: | N/A | | diff --git a/docs/models/reasoningitem.mdx b/docs/models/reasoningitem.mdx index 40ab7f523..36cceb129 100644 --- a/docs/models/reasoningitem.mdx +++ b/docs/models/reasoningitem.mdx @@ -25,11 +25,11 @@ let value: ReasoningItem = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `content` | [models.ReasoningTextContent](../models/reasoningtextcontent.mdx)[] | :heavy_minus_sign: | N/A | | +| `content` | [models.ReasoningTextContent](../models/reasoningtextcontent)[] | :heavy_minus_sign: | N/A | | | `encryptedContent` | *string* | :heavy_minus_sign: | N/A | | | `id` | *string* | :heavy_check_mark: | N/A | | | `status` | *models.ReasoningItemStatusUnion* | :heavy_minus_sign: | N/A | | -| `summary` | [models.ReasoningSummaryText](../models/reasoningsummarytext.mdx)[] | :heavy_check_mark: | N/A | | -| `type` | [models.ReasoningItemType](../models/reasoningitemtype.mdx) | :heavy_check_mark: | N/A | | -| `format` | [models.ReasoningFormat](../models/reasoningformat.mdx) | :heavy_minus_sign: | N/A | unknown | +| `summary` | [models.ReasoningSummaryText](../models/reasoningsummarytext)[] | :heavy_check_mark: | N/A | | +| `type` | [models.ReasoningItemType](../models/reasoningitemtype) | :heavy_check_mark: | N/A | | +| `format` | [models.ReasoningFormat](../models/reasoningformat) | :heavy_minus_sign: | N/A | unknown | | `signature` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/reasoningsummarypartaddedevent.mdx b/docs/models/reasoningsummarypartaddedevent.mdx index 581c4a947..a3eb07b64 100644 --- a/docs/models/reasoningsummarypartaddedevent.mdx +++ b/docs/models/reasoningsummarypartaddedevent.mdx @@ -28,7 +28,7 @@ let value: ReasoningSummaryPartAddedEvent = { | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | | `itemId` | *string* | :heavy_check_mark: | N/A | | | `outputIndex` | *number* | :heavy_check_mark: | N/A | | -| `part` | [models.ReasoningSummaryText](../models/reasoningsummarytext.mdx) | :heavy_check_mark: | N/A | \{
"text": "Analyzed the problem using first principles",
"type": "summary_text"
} | +| `part` | [models.ReasoningSummaryText](../models/reasoningsummarytext) | :heavy_check_mark: | N/A | \{
"text": "Analyzed the problem using first principles",
"type": "summary_text"
} | | `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | | `summaryIndex` | *number* | :heavy_check_mark: | N/A | | | `type` | *"response.reasoning_summary_part.added"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/reasoningsummarypartdoneevent.mdx b/docs/models/reasoningsummarypartdoneevent.mdx index 195b546bd..a6c573a43 100644 --- a/docs/models/reasoningsummarypartdoneevent.mdx +++ b/docs/models/reasoningsummarypartdoneevent.mdx @@ -28,7 +28,7 @@ let value: ReasoningSummaryPartDoneEvent = { | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | | `itemId` | *string* | :heavy_check_mark: | N/A | | | `outputIndex` | *number* | :heavy_check_mark: | N/A | | -| `part` | [models.ReasoningSummaryText](../models/reasoningsummarytext.mdx) | :heavy_check_mark: | N/A | \{
"text": "Analyzed the problem using first principles",
"type": "summary_text"
} | +| `part` | [models.ReasoningSummaryText](../models/reasoningsummarytext) | :heavy_check_mark: | N/A | \{
"text": "Analyzed the problem using first principles",
"type": "summary_text"
} | | `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | | `summaryIndex` | *number* | :heavy_check_mark: | N/A | | | `type` | *"response.reasoning_summary_part.done"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/reasoningsummarytext.mdx b/docs/models/reasoningsummarytext.mdx index 0339ed751..6fe6a8415 100644 --- a/docs/models/reasoningsummarytext.mdx +++ b/docs/models/reasoningsummarytext.mdx @@ -18,4 +18,4 @@ let value: ReasoningSummaryText = { | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | | `text` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.ReasoningSummaryTextType](../models/reasoningsummarytexttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.ReasoningSummaryTextType](../models/reasoningsummarytexttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/reasoningtextcontent.mdx b/docs/models/reasoningtextcontent.mdx index 0459188a5..84bc7c1e6 100644 --- a/docs/models/reasoningtextcontent.mdx +++ b/docs/models/reasoningtextcontent.mdx @@ -18,4 +18,4 @@ let value: ReasoningTextContent = { | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | | `text` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.ReasoningTextContentType](../models/reasoningtextcontenttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.ReasoningTextContentType](../models/reasoningtextcontenttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/requireapproval.mdx b/docs/models/requireapproval.mdx index dcdc75db6..d69763df6 100644 --- a/docs/models/requireapproval.mdx +++ b/docs/models/requireapproval.mdx @@ -14,5 +14,5 @@ let value: RequireApproval = {}; | Field | Type | Required | Description | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `always` | [models.Always](../models/always.mdx) | :heavy_minus_sign: | N/A | -| `never` | [models.Never](../models/never.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `always` | [models.Always](../models/always) | :heavy_minus_sign: | N/A | +| `never` | [models.Never](../models/never) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/responseoutputtext.mdx b/docs/models/responseoutputtext.mdx index adc4701bf..a4a6dcfbd 100644 --- a/docs/models/responseoutputtext.mdx +++ b/docs/models/responseoutputtext.mdx @@ -18,6 +18,6 @@ let value: ResponseOutputText = { | Field | Type | Required | Description | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | | `annotations` | *models.OpenAIResponsesAnnotation*[] | :heavy_minus_sign: | N/A | -| `logprobs` | [models.Logprob](../models/logprob.mdx)[] | :heavy_minus_sign: | N/A | +| `logprobs` | [models.Logprob](../models/logprob)[] | :heavy_minus_sign: | N/A | | `text` | *string* | :heavy_check_mark: | N/A | | `type` | *"output_text"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/responseserrorfield.mdx b/docs/models/responseserrorfield.mdx index 519b5c5a4..ffb1283d3 100644 --- a/docs/models/responseserrorfield.mdx +++ b/docs/models/responseserrorfield.mdx @@ -19,5 +19,5 @@ let value: ResponsesErrorField = { | Field | Type | Required | Description | | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -| `code` | [models.Code](../models/code.mdx) | :heavy_check_mark: | N/A | +| `code` | [models.Code](../models/code) | :heavy_check_mark: | N/A | | `message` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/responsesrequest.mdx b/docs/models/responsesrequest.mdx index 5af8e5d09..72c925c67 100644 --- a/docs/models/responsesrequest.mdx +++ b/docs/models/responsesrequest.mdx @@ -17,41 +17,41 @@ let value: ResponsesRequest = {}; | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `background` | *boolean* | :heavy_minus_sign: | N/A | | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/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` | [models.ChatDebugOptions](../models/chatdebugoptions.mdx) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective) | :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` | [models.ChatDebugOptions](../models/chatdebugoptions) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | | `frequencyPenalty` | *number* | :heavy_minus_sign: | N/A | | | `imageConfig` | Record\ | :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` | [models.ResponseIncludesEnum](../models/responseincludesenum.mdx)[] | :heavy_minus_sign: | N/A | | +| `include` | [models.ResponseIncludesEnum](../models/responseincludesenum)[] | :heavy_minus_sign: | N/A | | | `input` | *models.InputsUnion* | :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` | *string* | :heavy_minus_sign: | N/A | | | `maxOutputTokens` | *number* | :heavy_minus_sign: | N/A | | | `maxToolCalls` | *number* | :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` | Record\ | :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` | [models.OutputModalityEnum](../models/outputmodalityenum.mdx)[] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | +| `modalities` | [models.OutputModalityEnum](../models/outputmodalityenum)[] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | | `model` | *string* | :heavy_minus_sign: | N/A | | | `models` | *string*[] | :heavy_minus_sign: | N/A | | | `parallelToolCalls` | *boolean* | :heavy_minus_sign: | N/A | | | `plugins` | *models.ResponsesRequestPlugin*[] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | | `presencePenalty` | *number* | :heavy_minus_sign: | N/A | | | `previousResponseId` | *any* | :heavy_minus_sign: | Not supported. The Responses API is stateless: 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` | [models.StoredPromptTemplate](../models/storedprompttemplate.mdx) | :heavy_minus_sign: | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | +| `prompt` | [models.StoredPromptTemplate](../models/storedprompttemplate) | :heavy_minus_sign: | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | | `promptCacheKey` | *string* | :heavy_minus_sign: | N/A | | -| `promptCacheOptions` | [models.PromptCacheOptions](../models/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` | [models.ProviderPreferences](../models/providerpreferences.mdx) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `reasoning` | [models.ReasoningConfig](../models/reasoningconfig.mdx) | :heavy_minus_sign: | Configuration for reasoning mode in the response | \{
"enabled": true,
"summary": "auto"
} | +| `promptCacheOptions` | [models.PromptCacheOptions](../models/promptcacheoptions) | :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` | [models.ProviderPreferences](../models/providerpreferences) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `reasoning` | [models.ReasoningConfig](../models/reasoningconfig) | :heavy_minus_sign: | Configuration for reasoning mode in the response | \{
"enabled": true,
"summary": "auto"
} | | `safetyIdentifier` | *string* | :heavy_minus_sign: | Recommended per-end-user identifier for abuse isolation. Use a stable ID, hash, or pseudonym. When a provider requires a user identity, OpenRouter folds it into the hashed identity sent upstream and never forwards it raw. If omitted, requests use an account-level identity, so provider policy blocks can affect the whole account. | user-123 | -| `serviceTier` | [models.ResponsesRequestServiceTier](../models/responsesrequestservicetier.mdx) | :heavy_minus_sign: | N/A | | +| `serviceTier` | [models.ResponsesRequestServiceTier](../models/responsesrequestservicetier) | :heavy_minus_sign: | N/A | | | `sessionId` | *string* | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). When provided, OpenRouter uses it as the sticky routing key, routing all requests in the session to the same provider to maximize prompt cache hits. Also used for observability grouping. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | | | `stopServerToolsWhen` | *models.StopServerToolsWhenCondition*[] | :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` | *false* | :heavy_minus_sign: | N/A | | | `stream` | *boolean* | :heavy_minus_sign: | N/A | | | `temperature` | *number* | :heavy_minus_sign: | N/A | | -| `text` | [models.TextExtendedConfig](../models/textextendedconfig.mdx) | :heavy_minus_sign: | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | +| `text` | [models.TextExtendedConfig](../models/textextendedconfig) | :heavy_minus_sign: | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | | `toolChoice` | *models.OpenAIResponsesToolChoiceUnion* | :heavy_minus_sign: | N/A | auto | | `tools` | *models.ResponsesRequestToolUnion*[] | :heavy_minus_sign: | N/A | | | `topK` | *number* | :heavy_minus_sign: | N/A | | | `topLogprobs` | *number* | :heavy_minus_sign: | N/A | | | `topP` | *number* | :heavy_minus_sign: | N/A | | -| `trace` | [models.TraceConfig](../models/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` | [models.OpenAIResponsesTruncation](../models/openairesponsestruncation.mdx) | :heavy_minus_sign: | N/A | auto | +| `trace` | [models.TraceConfig](../models/traceconfig) | :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` | [models.OpenAIResponsesTruncation](../models/openairesponsestruncation) | :heavy_minus_sign: | N/A | auto | | `user` | *string* | :heavy_minus_sign: | A unique identifier representing your end-user, which helps distinguish between different users of your app. This allows your app to identify specific users in case of abuse reports, preventing your entire app from being affected by the actions of individual users. Maximum of 256 characters. | | \ No newline at end of file diff --git a/docs/models/rule.mdx b/docs/models/rule.mdx index d648f9009..235651b47 100644 --- a/docs/models/rule.mdx +++ b/docs/models/rule.mdx @@ -17,6 +17,6 @@ let value: Rule = { | Field | Type | Required | Description | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `field` | [models.Field](../models/field.mdx) | :heavy_check_mark: | N/A | -| `operator` | [models.Operator](../models/operator.mdx) | :heavy_check_mark: | N/A | +| `field` | [models.Field](../models/field) | :heavy_check_mark: | N/A | +| `operator` | [models.Operator](../models/operator) | :heavy_check_mark: | N/A | | `value` | *models.ObservabilityFilterRuleGroupValue* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/searchmodelsservertoolopenrouter.mdx b/docs/models/searchmodelsservertoolopenrouter.mdx index ca140b034..407469069 100644 --- a/docs/models/searchmodelsservertoolopenrouter.mdx +++ b/docs/models/searchmodelsservertoolopenrouter.mdx @@ -18,5 +18,5 @@ let value: SearchModelsServerToolOpenRouter = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `parameters` | [models.SearchModelsServerToolConfig](../models/searchmodelsservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | -| `type` | [models.SearchModelsServerToolOpenRouterType](../models/searchmodelsservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.SearchModelsServerToolConfig](../models/searchmodelsservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | +| `type` | [models.SearchModelsServerToolOpenRouterType](../models/searchmodelsservertoolopenroutertype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shellcallitem.mdx b/docs/models/shellcallitem.mdx index b30da1e3b..98a62e2a0 100644 --- a/docs/models/shellcallitem.mdx +++ b/docs/models/shellcallitem.mdx @@ -25,9 +25,9 @@ let value: ShellCallItem = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `action` | [models.ShellCallItemAction](../models/shellcallitemaction.mdx) | :heavy_check_mark: | N/A | | +| `action` | [models.ShellCallItemAction](../models/shellcallitemaction) | :heavy_check_mark: | N/A | | | `callId` | *string* | :heavy_check_mark: | N/A | | | `environment` | *any* | :heavy_minus_sign: | N/A | | | `id` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | -| `type` | [models.ShellCallItemType](../models/shellcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `status` | [models.ToolCallStatus](../models/toolcallstatus) | :heavy_minus_sign: | N/A | completed | +| `type` | [models.ShellCallItemType](../models/shellcallitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shellcalloutputitem.mdx b/docs/models/shellcalloutputitem.mdx index 44f2b1477..0ca8297da 100644 --- a/docs/models/shellcalloutputitem.mdx +++ b/docs/models/shellcalloutputitem.mdx @@ -27,6 +27,6 @@ let value: ShellCallOutputItem = { | `callId` | *string* | :heavy_check_mark: | N/A | | | `id` | *string* | :heavy_minus_sign: | N/A | | | `maxOutputLength` | *number* | :heavy_minus_sign: | N/A | | -| `output` | [models.ShellCallOutputItemOutput](../models/shellcalloutputitemoutput.mdx)[] | :heavy_check_mark: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | -| `type` | [models.ShellCallOutputItemType](../models/shellcalloutputitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `output` | [models.ShellCallOutputItemOutput](../models/shellcalloutputitemoutput)[] | :heavy_check_mark: | N/A | | +| `status` | [models.ToolCallStatus](../models/toolcallstatus) | :heavy_minus_sign: | N/A | completed | +| `type` | [models.ShellCallOutputItemType](../models/shellcalloutputitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shellservertool.mdx b/docs/models/shellservertool.mdx index e617ecf21..61743a884 100644 --- a/docs/models/shellservertool.mdx +++ b/docs/models/shellservertool.mdx @@ -18,4 +18,4 @@ let value: ShellServerTool = { | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `type` | [models.ShellServerToolType](../models/shellservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.ShellServerToolType](../models/shellservertooltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shellservertoolconfig.mdx b/docs/models/shellservertoolconfig.mdx index ef0f66ee2..70648aa7d 100644 --- a/docs/models/shellservertoolconfig.mdx +++ b/docs/models/shellservertoolconfig.mdx @@ -16,6 +16,6 @@ let value: ShellServerToolConfig = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `engine` | [models.ShellServerToolEngine](../models/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 | +| `engine` | [models.ShellServerToolEngine](../models/shellservertoolengine) | :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` | *models.ShellServerToolEnvironment* | :heavy_minus_sign: | Server-side execution environment for the shell tool. Only container-backed environments are supported; "local" shells are not. | \{
"type": "container_auto"
} | | `sleepAfterSeconds` | *number* | :heavy_minus_sign: | How long (in seconds) the container stays warm after its last command before sleeping, freeing its capacity slot. Idle-based: each command renews the timer. Defaults to 900 (15 minutes); capped at 2592000 (30 days). | 900 | \ No newline at end of file diff --git a/docs/models/shellservertoolopenrouter.mdx b/docs/models/shellservertoolopenrouter.mdx index 95e2b08a8..b19a03278 100644 --- a/docs/models/shellservertoolopenrouter.mdx +++ b/docs/models/shellservertoolopenrouter.mdx @@ -18,5 +18,5 @@ let value: ShellServerToolOpenRouter = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `parameters` | [models.ShellServerToolConfig](../models/shellservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:shell server tool | \{
"engine": "openrouter",
"environment": \{
"type": "container_auto"
}
} | -| `type` | [models.ShellServerToolOpenRouterType](../models/shellservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.ShellServerToolConfig](../models/shellservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:shell server tool | \{
"engine": "openrouter",
"environment": \{
"type": "container_auto"
}
} | +| `type` | [models.ShellServerToolOpenRouterType](../models/shellservertoolopenroutertype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/speechrequest.mdx b/docs/models/speechrequest.mdx index f4547cde0..e9edb23a9 100644 --- a/docs/models/speechrequest.mdx +++ b/docs/models/speechrequest.mdx @@ -22,7 +22,7 @@ let value: SpeechRequest = { | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | | `input` | *string* | :heavy_check_mark: | Text to synthesize | Hello world | | `model` | *string* | :heavy_check_mark: | TTS model identifier | mistralai/voxtral-mini-tts-2603 | -| `provider` | [models.SpeechRequestProvider](../models/speechrequestprovider.mdx) | :heavy_minus_sign: | Provider-specific passthrough configuration | | -| `responseFormat` | [models.SpeechRequestResponseFormat](../models/speechrequestresponseformat.mdx) | :heavy_minus_sign: | Audio output format | pcm | +| `provider` | [models.SpeechRequestProvider](../models/speechrequestprovider) | :heavy_minus_sign: | Provider-specific passthrough configuration | | +| `responseFormat` | [models.SpeechRequestResponseFormat](../models/speechrequestresponseformat) | :heavy_minus_sign: | Audio output format | pcm | | `speed` | *number* | :heavy_minus_sign: | Playback speed multiplier. Only used by models that support it (e.g. OpenAI TTS). Ignored by other providers. | 1 | | `voice` | *string* | :heavy_check_mark: | Voice identifier (provider-specific). | en_paul_neutral | \ No newline at end of file diff --git a/docs/models/speechrequestprovider.mdx b/docs/models/speechrequestprovider.mdx index 7df1d6454..a8ae19af5 100644 --- a/docs/models/speechrequestprovider.mdx +++ b/docs/models/speechrequestprovider.mdx @@ -16,4 +16,4 @@ let value: SpeechRequestProvider = {}; | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `options` | [models.ProviderOptions](../models/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
}
} | \ No newline at end of file +| `options` | [models.ProviderOptions](../models/provideroptions) | :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
}
} | \ No newline at end of file diff --git a/docs/models/streameventsresponsecompleted.mdx b/docs/models/streameventsresponsecompleted.mdx index 6591fff0c..24cc90bff 100644 --- a/docs/models/streameventsresponsecompleted.mdx +++ b/docs/models/streameventsresponsecompleted.mdx @@ -39,6 +39,6 @@ let value: StreamEventsResponseCompleted = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [models.OpenResponsesResult](../models/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
}
} | +| `response` | [models.OpenResponsesResult](../models/openresponsesresult) | :heavy_check_mark: | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | | `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | | `type` | *"response.completed"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/streameventsresponsefailed.mdx b/docs/models/streameventsresponsefailed.mdx index e5d078e19..390b08187 100644 --- a/docs/models/streameventsresponsefailed.mdx +++ b/docs/models/streameventsresponsefailed.mdx @@ -39,6 +39,6 @@ let value: StreamEventsResponseFailed = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [models.OpenResponsesResult](../models/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
}
} | +| `response` | [models.OpenResponsesResult](../models/openresponsesresult) | :heavy_check_mark: | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | | `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | | `type` | *"response.failed"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/streameventsresponseincomplete.mdx b/docs/models/streameventsresponseincomplete.mdx index df4f85a38..79d4491a9 100644 --- a/docs/models/streameventsresponseincomplete.mdx +++ b/docs/models/streameventsresponseincomplete.mdx @@ -39,6 +39,6 @@ let value: StreamEventsResponseIncomplete = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [models.OpenResponsesResult](../models/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
}
} | +| `response` | [models.OpenResponsesResult](../models/openresponsesresult) | :heavy_check_mark: | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | | `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | | `type` | *"response.incomplete"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/streamlogprob.mdx b/docs/models/streamlogprob.mdx index eb20d99cb..6d5d4bf70 100644 --- a/docs/models/streamlogprob.mdx +++ b/docs/models/streamlogprob.mdx @@ -22,4 +22,4 @@ let value: StreamLogprob = { | `bytes` | *number*[] | :heavy_minus_sign: | N/A | | `logprob` | *number* | :heavy_check_mark: | N/A | | `token` | *string* | :heavy_check_mark: | N/A | -| `topLogprobs` | [models.StreamLogprobTopLogprob](../models/streamlogprobtoplogprob.mdx)[] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `topLogprobs` | [models.StreamLogprobTopLogprob](../models/streamlogprobtoplogprob)[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/sttrequest.mdx b/docs/models/sttrequest.mdx index a73202bfd..276621978 100644 --- a/docs/models/sttrequest.mdx +++ b/docs/models/sttrequest.mdx @@ -22,10 +22,10 @@ let value: STTRequest = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `inputAudio` | [models.STTInputAudio](../models/sttinputaudio.mdx) | :heavy_check_mark: | Base64-encoded audio to transcribe | \{
"data": "UklGRiQA...",
"format": "wav"
} | +| `inputAudio` | [models.STTInputAudio](../models/sttinputaudio) | :heavy_check_mark: | Base64-encoded audio to transcribe | \{
"data": "UklGRiQA...",
"format": "wav"
} | | `language` | *string* | :heavy_minus_sign: | ISO-639-1 language code (e.g., "en", "ja"). Auto-detected if omitted. | en | | `model` | *string* | :heavy_check_mark: | STT model identifier | openai/whisper-large-v3 | -| `provider` | [models.STTRequestProvider](../models/sttrequestprovider.mdx) | :heavy_minus_sign: | Provider-specific passthrough configuration | | -| `responseFormat` | [models.STTRequestResponseFormat](../models/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 | +| `provider` | [models.STTRequestProvider](../models/sttrequestprovider) | :heavy_minus_sign: | Provider-specific passthrough configuration | | +| `responseFormat` | [models.STTRequestResponseFormat](../models/sttrequestresponseformat) | :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 | | `temperature` | *number* | :heavy_minus_sign: | Sampling temperature for transcription | 0 | -| `timestampGranularities` | [models.STTTimestampGranularity](../models/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"
] | \ No newline at end of file +| `timestampGranularities` | [models.STTTimestampGranularity](../models/stttimestampgranularity)[] | :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"
] | \ No newline at end of file diff --git a/docs/models/sttrequestprovider.mdx b/docs/models/sttrequestprovider.mdx index 0c02e68fb..3e66e0398 100644 --- a/docs/models/sttrequestprovider.mdx +++ b/docs/models/sttrequestprovider.mdx @@ -16,4 +16,4 @@ let value: STTRequestProvider = {}; | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `options` | [models.ProviderOptions](../models/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
}
} | \ No newline at end of file +| `options` | [models.ProviderOptions](../models/provideroptions) | :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
}
} | \ No newline at end of file diff --git a/docs/models/sttresponse.mdx b/docs/models/sttresponse.mdx index 2669680d7..b7cb56b4c 100644 --- a/docs/models/sttresponse.mdx +++ b/docs/models/sttresponse.mdx @@ -20,8 +20,8 @@ let value: STTResponse = { | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `duration` | *number* | :heavy_minus_sign: | Duration of the input audio in seconds, present when response_format is verbose_json | 9.2 | | `language` | *string* | :heavy_minus_sign: | Detected or forced language, present when response_format is verbose_json | english | -| `segments` | [models.STTSegment](../models/sttsegment.mdx)[] | :heavy_minus_sign: | Timestamped transcript segments, present when response_format is verbose_json | | +| `segments` | [models.STTSegment](../models/sttsegment)[] | :heavy_minus_sign: | Timestamped transcript segments, present when response_format is verbose_json | | | `task` | *string* | :heavy_minus_sign: | The task performed, present when response_format is verbose_json | transcribe | | `text` | *string* | :heavy_check_mark: | The transcribed text | Hello, this is a test of OpenAI speech-to-text transcription. The weather is sunny today and the temperature is around 72 degrees. | -| `usage` | [models.STTUsage](../models/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` | [models.STTWord](../models/sttword.mdx)[] | :heavy_minus_sign: | Timestamped words, present when the provider returns word-level timestamps | | \ No newline at end of file +| `usage` | [models.STTUsage](../models/sttusage) | :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` | [models.STTWord](../models/sttword)[] | :heavy_minus_sign: | Timestamped words, present when the provider returns word-level timestamps | | \ No newline at end of file diff --git a/docs/models/subagentreasoning.mdx b/docs/models/subagentreasoning.mdx index f59f24290..576a94bf0 100644 --- a/docs/models/subagentreasoning.mdx +++ b/docs/models/subagentreasoning.mdx @@ -16,5 +16,5 @@ let value: SubagentReasoning = {}; | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | -| `effort` | [models.SubagentReasoningEffort](../models/subagentreasoningeffort.mdx) | :heavy_minus_sign: | Reasoning effort level for the subagent call. | +| `effort` | [models.SubagentReasoningEffort](../models/subagentreasoningeffort) | :heavy_minus_sign: | Reasoning effort level for the subagent call. | | `maxTokens` | *number* | :heavy_minus_sign: | Maximum number of reasoning tokens the subagent may use. Accepted and validated but not yet forwarded to the subagent call. | \ No newline at end of file diff --git a/docs/models/subagentservertoolconfig.mdx b/docs/models/subagentservertoolconfig.mdx index 4123696d4..b322d4382 100644 --- a/docs/models/subagentservertoolconfig.mdx +++ b/docs/models/subagentservertoolconfig.mdx @@ -21,6 +21,6 @@ let value: SubagentServerToolConfig = {}; | `maxToolCalls` | *number* | :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. Accepted and validated but not yet enforced on the subagent call. | 5 | | `model` | *string* | :heavy_minus_sign: | Slug of the model that executes delegated tasks (any OpenRouter model). Typically a smaller, cheaper, faster model than the one delegating. When omitted, the model from the outer API request is used. The subagent tool itself cannot be the subagent model. | ~anthropic/claude-haiku-latest | | `name` | *string* | :heavy_minus_sign: | Optional name for this subagent. The model sees one tool per named subagent (and one default for an unnamed entry). Names must be unique across subagent entries. Letters, digits, spaces, underscores, and dashes; trimmed; 1–64 chars. | summarizer | -| `reasoning` | [models.SubagentReasoning](../models/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"
} | +| `reasoning` | [models.SubagentReasoning](../models/subagentreasoning) | :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` | *number* | :heavy_minus_sign: | Sampling temperature forwarded to the subagent call. When omitted, the provider's default applies. | 0.7 | -| `tools` | [models.SubagentNestedTool](../models/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 +| `tools` | [models.SubagentNestedTool](../models/subagentnestedtool)[] | :heavy_minus_sign: | Tools the subagent may use while executing a delegated task. The subagent runs as an agentic sub-agent over these tools, then returns its outcome. Only OpenRouter server tools are supported — function tools are rejected — and the list must not include the subagent tool itself. | | \ No newline at end of file diff --git a/docs/models/subagentservertoolopenrouter.mdx b/docs/models/subagentservertoolopenrouter.mdx index 3d1923156..a56278c85 100644 --- a/docs/models/subagentservertoolopenrouter.mdx +++ b/docs/models/subagentservertoolopenrouter.mdx @@ -18,5 +18,5 @@ let value: SubagentServerToolOpenRouter = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `parameters` | [models.SubagentServerToolConfig](../models/subagentservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for one openrouter:subagent server tool entry. | \{
"model": "~anthropic/claude-haiku-latest",
"name": "summarizer"
} | -| `type` | [models.SubagentServerToolOpenRouterType](../models/subagentservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.SubagentServerToolConfig](../models/subagentservertoolconfig) | :heavy_minus_sign: | Configuration for one openrouter:subagent server tool entry. | \{
"model": "~anthropic/claude-haiku-latest",
"name": "summarizer"
} | +| `type` | [models.SubagentServerToolOpenRouterType](../models/subagentservertoolopenroutertype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/submitgenerationfeedbackrequest.mdx b/docs/models/submitgenerationfeedbackrequest.mdx index db7043f72..f6a3dc9f9 100644 --- a/docs/models/submitgenerationfeedbackrequest.mdx +++ b/docs/models/submitgenerationfeedbackrequest.mdx @@ -19,6 +19,6 @@ let value: SubmitGenerationFeedbackRequest = { | Field | Type | Required | Description | Example | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `category` | [models.Category](../models/category.mdx) | :heavy_check_mark: | The category of feedback being reported | incorrect_response | +| `category` | [models.Category](../models/category) | :heavy_check_mark: | The category of feedback being reported | incorrect_response | | `comment` | *string* | :heavy_minus_sign: | An optional free-text comment describing the feedback | The model repeated the same paragraph three times. | | `generationId` | *string* | :heavy_check_mark: | The generation to submit feedback on | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | \ No newline at end of file diff --git a/docs/models/submitgenerationfeedbackresponse.mdx b/docs/models/submitgenerationfeedbackresponse.mdx index 5c73a0966..d11dea541 100644 --- a/docs/models/submitgenerationfeedbackresponse.mdx +++ b/docs/models/submitgenerationfeedbackresponse.mdx @@ -20,4 +20,4 @@ let value: SubmitGenerationFeedbackResponse = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `data` | [models.SubmitGenerationFeedbackResponseData](../models/submitgenerationfeedbackresponsedata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [models.SubmitGenerationFeedbackResponseData](../models/submitgenerationfeedbackresponsedata) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/taskbudget.mdx b/docs/models/taskbudget.mdx index bfcc958be..fccf5d0a2 100644 --- a/docs/models/taskbudget.mdx +++ b/docs/models/taskbudget.mdx @@ -21,4 +21,4 @@ let value: TaskBudget = { | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | | `remaining` | *number* | :heavy_minus_sign: | N/A | | `total` | *number* | :heavy_check_mark: | N/A | -| `type` | [models.TypeTokens](../models/typetokens.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.TypeTokens](../models/typetokens) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/taskclassificationitem.mdx b/docs/models/taskclassificationitem.mdx index e5b5195c3..793f119d8 100644 --- a/docs/models/taskclassificationitem.mdx +++ b/docs/models/taskclassificationitem.mdx @@ -38,7 +38,7 @@ let value: TaskClassificationItem = { | `categoryUsageShare` | *number* | :heavy_check_mark: | Fraction of this classification's usage within its macro-category (0–1). Sums to 1 across all classifications sharing the same `macro_category`. | 0.51 | | `displayName` | *string* | :heavy_check_mark: | Human-readable label for the classification. | Code Generation | | `macroCategory` | *string* | :heavy_check_mark: | Coarse grouping derived from the tag prefix: `code`, `data`, `agent`, or `general`. | code | -| `models` | [models.TaskClassificationModel](../models/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. | | +| `models` | [models.TaskClassificationModel](../models/taskclassificationmodel)[] | :heavy_check_mark: | Top models for this classification by request volume, sorted descending. Each entry reports the model's share of this classification's requests and tokens. | | | `tag` | *string* | :heavy_check_mark: | Classification tag identifier (e.g. `code:general_impl`, `agent:web_search`). | code:general_impl | | `tokenShare` | *number* | :heavy_check_mark: | Fraction of classified sampled token volume (prompt + completion) attributed to this classification (0–1). The unclassified `other` bucket is excluded from the denominator. | 0.31 | | `usageShare` | *number* | :heavy_check_mark: | Fraction of classified sampled requests attributed to this classification (0–1). The unclassified `other` bucket is excluded from the denominator. | 0.23 | \ No newline at end of file diff --git a/docs/models/taskclassificationresponse.mdx b/docs/models/taskclassificationresponse.mdx index b995ba16d..30766f2d3 100644 --- a/docs/models/taskclassificationresponse.mdx +++ b/docs/models/taskclassificationresponse.mdx @@ -45,4 +45,4 @@ let value: TaskClassificationResponse = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `data` | [models.TaskClassificationResponseData](../models/taskclassificationresponsedata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [models.TaskClassificationResponseData](../models/taskclassificationresponsedata) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/taskclassificationresponsedata.mdx b/docs/models/taskclassificationresponsedata.mdx index 9a23a83b4..96b3c5ec3 100644 --- a/docs/models/taskclassificationresponsedata.mdx +++ b/docs/models/taskclassificationresponsedata.mdx @@ -49,6 +49,6 @@ let value: TaskClassificationResponseData = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `asOf` | *string* | :heavy_check_mark: | UTC date (YYYY-MM-DD) of the window upper bound (yesterday). Data is exclusive of the current incomplete UTC day. This is the expected latest date in the snapshot; it does not confirm data presence for that date. | 2026-06-17 | -| `classifications` | [models.TaskClassificationItem](../models/taskclassificationitem.mdx)[] | :heavy_check_mark: | Per-task classification market-share data, sorted by usage_share descending. | | -| `macroCategories` | [models.TaskClassificationMacroCategory](../models/taskclassificationmacrocategory.mdx)[] | :heavy_check_mark: | Aggregate market-share data per macro-category (code, data, agent, general). | | +| `classifications` | [models.TaskClassificationItem](../models/taskclassificationitem)[] | :heavy_check_mark: | Per-task classification market-share data, sorted by usage_share descending. | | +| `macroCategories` | [models.TaskClassificationMacroCategory](../models/taskclassificationmacrocategory)[] | :heavy_check_mark: | Aggregate market-share data per macro-category (code, data, agent, general). | | | `windowDays` | *number* | :heavy_check_mark: | Number of trailing days covered by this snapshot. | 7 | \ No newline at end of file diff --git a/docs/models/textdeltaevent.mdx b/docs/models/textdeltaevent.mdx index 182d80a07..9ed4b63e0 100644 --- a/docs/models/textdeltaevent.mdx +++ b/docs/models/textdeltaevent.mdx @@ -32,7 +32,7 @@ let value: TextDeltaEvent = { | `contentIndex` | *number* | :heavy_check_mark: | N/A | | `delta` | *string* | :heavy_check_mark: | N/A | | `itemId` | *string* | :heavy_check_mark: | N/A | -| `logprobs` | [models.StreamLogprob](../models/streamlogprob.mdx)[] | :heavy_check_mark: | N/A | +| `logprobs` | [models.StreamLogprob](../models/streamlogprob)[] | :heavy_check_mark: | N/A | | `outputIndex` | *number* | :heavy_check_mark: | N/A | | `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | `type` | *"response.output_text.delta"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/textdoneevent.mdx b/docs/models/textdoneevent.mdx index 02f6aad81..ab126adf7 100644 --- a/docs/models/textdoneevent.mdx +++ b/docs/models/textdoneevent.mdx @@ -31,7 +31,7 @@ let value: TextDoneEvent = { | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | | `contentIndex` | *number* | :heavy_check_mark: | N/A | | `itemId` | *string* | :heavy_check_mark: | N/A | -| `logprobs` | [models.StreamLogprob](../models/streamlogprob.mdx)[] | :heavy_check_mark: | N/A | +| `logprobs` | [models.StreamLogprob](../models/streamlogprob)[] | :heavy_check_mark: | N/A | | `outputIndex` | *number* | :heavy_check_mark: | N/A | | `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | `text` | *string* | :heavy_check_mark: | N/A | diff --git a/docs/models/textextendedconfig.mdx b/docs/models/textextendedconfig.mdx index dd0fe65fe..515006ce1 100644 --- a/docs/models/textextendedconfig.mdx +++ b/docs/models/textextendedconfig.mdx @@ -17,4 +17,4 @@ let value: TextExtendedConfig = {}; | Field | Type | Required | Description | Example | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | | `format` | *models.Formats* | :heavy_minus_sign: | Text response format configuration | \{
"type": "text"
} | -| `verbosity` | [models.Verbosity](../models/verbosity.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `verbosity` | [models.Verbosity](../models/verbosity) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/thinkingadaptive.mdx b/docs/models/thinkingadaptive.mdx index 561a342de..993e492b9 100644 --- a/docs/models/thinkingadaptive.mdx +++ b/docs/models/thinkingadaptive.mdx @@ -16,5 +16,5 @@ let value: ThinkingAdaptive = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `display` | [models.AnthropicThinkingDisplay](../models/anthropicthinkingdisplay.mdx) | :heavy_minus_sign: | N/A | summarized | +| `display` | [models.AnthropicThinkingDisplay](../models/anthropicthinkingdisplay) | :heavy_minus_sign: | N/A | summarized | | `type` | *"adaptive"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/thinkingenabled.mdx b/docs/models/thinkingenabled.mdx index 2c93b726f..f5d3b9f3a 100644 --- a/docs/models/thinkingenabled.mdx +++ b/docs/models/thinkingenabled.mdx @@ -18,5 +18,5 @@ let value: ThinkingEnabled = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | | `budgetTokens` | *number* | :heavy_check_mark: | N/A | | -| `display` | [models.AnthropicThinkingDisplay](../models/anthropicthinkingdisplay.mdx) | :heavy_minus_sign: | N/A | summarized | +| `display` | [models.AnthropicThinkingDisplay](../models/anthropicthinkingdisplay) | :heavy_minus_sign: | N/A | summarized | | `type` | *"enabled"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/timings.mdx b/docs/models/timings.mdx index d4887bbdf..5d93593a5 100644 --- a/docs/models/timings.mdx +++ b/docs/models/timings.mdx @@ -19,5 +19,5 @@ let value: Timings = { | Field | Type | Required | Description | | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | | `epochMs` | *number* | :heavy_check_mark: | N/A | -| `event` | [models.Event](../models/event.mdx) | :heavy_check_mark: | N/A | +| `event` | [models.Event](../models/event) | :heavy_check_mark: | N/A | | `startMs` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/tooladvisor20260301.mdx b/docs/models/tooladvisor20260301.mdx index 060f636c6..1fde1cb1f 100644 --- a/docs/models/tooladvisor20260301.mdx +++ b/docs/models/tooladvisor20260301.mdx @@ -18,11 +18,11 @@ let value: ToolAdvisor20260301 = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allowedCallers` | [models.AnthropicAllowedCallers](../models/anthropicallowedcallers.mdx)[] | :heavy_minus_sign: | N/A | [
"direct"
] | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/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` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | N/A | \{
"type": "ephemeral"
} | +| `allowedCallers` | [models.AnthropicAllowedCallers](../models/anthropicallowedcallers)[] | :heavy_minus_sign: | N/A | [
"direct"
] | +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective) | :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` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective) | :heavy_minus_sign: | N/A | \{
"type": "ephemeral"
} | | `deferLoading` | *boolean* | :heavy_minus_sign: | N/A | | | `maxUses` | *number* | :heavy_minus_sign: | N/A | | | `model` | *string* | :heavy_check_mark: | N/A | | -| `name` | [models.NameAdvisor](../models/nameadvisor.mdx) | :heavy_check_mark: | N/A | | -| `type` | [models.TypeAdvisor20260301](../models/typeadvisor20260301.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `name` | [models.NameAdvisor](../models/nameadvisor) | :heavy_check_mark: | N/A | | +| `type` | [models.TypeAdvisor20260301](../models/typeadvisor20260301) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/toolbash20250124.mdx b/docs/models/toolbash20250124.mdx index 78b851952..176290596 100644 --- a/docs/models/toolbash20250124.mdx +++ b/docs/models/toolbash20250124.mdx @@ -17,6 +17,6 @@ let value: ToolBash20250124 = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/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` | [models.NameBash](../models/namebash.mdx) | :heavy_check_mark: | N/A | | -| `type` | [models.TypeBash20250124](../models/typebash20250124.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective) | :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` | [models.NameBash](../models/namebash) | :heavy_check_mark: | N/A | | +| `type` | [models.TypeBash20250124](../models/typebash20250124) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/toolchoiceallowed.mdx b/docs/models/toolchoiceallowed.mdx index 36569b68e..cbb1a3fb1 100644 --- a/docs/models/toolchoiceallowed.mdx +++ b/docs/models/toolchoiceallowed.mdx @@ -27,4 +27,4 @@ let value: ToolChoiceAllowed = { | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | | `mode` | *models.Mode* | :heavy_check_mark: | N/A | | `tools` | Record\[] | :heavy_check_mark: | N/A | -| `type` | [models.ToolChoiceAllowedType](../models/toolchoiceallowedtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.ToolChoiceAllowedType](../models/toolchoiceallowedtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/toolcustom.mdx b/docs/models/toolcustom.mdx index 4134908d5..5b2175fea 100644 --- a/docs/models/toolcustom.mdx +++ b/docs/models/toolcustom.mdx @@ -17,9 +17,9 @@ let value: ToolCustom = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/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"
} | +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | | `deferLoading` | *boolean* | :heavy_minus_sign: | N/A | | | `description` | *string* | :heavy_minus_sign: | N/A | | -| `inputSchema` | [models.InputSchema](../models/inputschema.mdx) | :heavy_check_mark: | N/A | | +| `inputSchema` | [models.InputSchema](../models/inputschema) | :heavy_check_mark: | N/A | | | `name` | *string* | :heavy_check_mark: | N/A | | -| `type` | [models.ToolTypeCustom](../models/tooltypecustom.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `type` | [models.ToolTypeCustom](../models/tooltypecustom) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/tooltexteditor20250124.mdx b/docs/models/tooltexteditor20250124.mdx index 9b821dc85..4eddcfc5f 100644 --- a/docs/models/tooltexteditor20250124.mdx +++ b/docs/models/tooltexteditor20250124.mdx @@ -17,6 +17,6 @@ let value: ToolTextEditor20250124 = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/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` | [models.NameStrReplaceEditor](../models/namestrreplaceeditor.mdx) | :heavy_check_mark: | N/A | | -| `type` | [models.TypeTextEditor20250124](../models/typetexteditor20250124.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective) | :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` | [models.NameStrReplaceEditor](../models/namestrreplaceeditor) | :heavy_check_mark: | N/A | | +| `type` | [models.TypeTextEditor20250124](../models/typetexteditor20250124) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/toolwebsearch20250305.mdx b/docs/models/toolwebsearch20250305.mdx index e39bf6779..b54f04604 100644 --- a/docs/models/toolwebsearch20250305.mdx +++ b/docs/models/toolwebsearch20250305.mdx @@ -19,8 +19,8 @@ let value: ToolWebSearch20250305 = { | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `allowedDomains` | *string*[] | :heavy_minus_sign: | N/A | | | `blockedDomains` | *string*[] | :heavy_minus_sign: | N/A | | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/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"
} | +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | | `maxUses` | *number* | :heavy_minus_sign: | N/A | | -| `name` | [models.NameWebSearch1](../models/namewebsearch1.mdx) | :heavy_check_mark: | N/A | | -| `type` | [models.TypeWebSearch20250305](../models/typewebsearch20250305.mdx) | :heavy_check_mark: | N/A | | -| `userLocation` | [models.AnthropicWebSearchToolUserLocation](../models/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 +| `name` | [models.NameWebSearch1](../models/namewebsearch1) | :heavy_check_mark: | N/A | | +| `type` | [models.TypeWebSearch20250305](../models/typewebsearch20250305) | :heavy_check_mark: | N/A | | +| `userLocation` | [models.AnthropicWebSearchToolUserLocation](../models/anthropicwebsearchtooluserlocation) | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file diff --git a/docs/models/toolwebsearch20260209.mdx b/docs/models/toolwebsearch20260209.mdx index 3934627a7..6e40e6d87 100644 --- a/docs/models/toolwebsearch20260209.mdx +++ b/docs/models/toolwebsearch20260209.mdx @@ -17,11 +17,11 @@ let value: ToolWebSearch20260209 = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allowedCallers` | [models.AnthropicAllowedCallers](../models/anthropicallowedcallers.mdx)[] | :heavy_minus_sign: | N/A | [
"direct"
] | +| `allowedCallers` | [models.AnthropicAllowedCallers](../models/anthropicallowedcallers)[] | :heavy_minus_sign: | N/A | [
"direct"
] | | `allowedDomains` | *string*[] | :heavy_minus_sign: | N/A | | | `blockedDomains` | *string*[] | :heavy_minus_sign: | N/A | | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/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"
} | +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | | `maxUses` | *number* | :heavy_minus_sign: | N/A | | -| `name` | [models.NameWebSearch2](../models/namewebsearch2.mdx) | :heavy_check_mark: | N/A | | -| `type` | [models.TypeWebSearch20260209](../models/typewebsearch20260209.mdx) | :heavy_check_mark: | N/A | | -| `userLocation` | [models.AnthropicWebSearchToolUserLocation](../models/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 +| `name` | [models.NameWebSearch2](../models/namewebsearch2) | :heavy_check_mark: | N/A | | +| `type` | [models.TypeWebSearch20260209](../models/typewebsearch20260209) | :heavy_check_mark: | N/A | | +| `userLocation` | [models.AnthropicWebSearchToolUserLocation](../models/anthropicwebsearchtooluserlocation) | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file diff --git a/docs/models/triggerinputtokens.mdx b/docs/models/triggerinputtokens.mdx index 007b8789e..856d4f37d 100644 --- a/docs/models/triggerinputtokens.mdx +++ b/docs/models/triggerinputtokens.mdx @@ -17,5 +17,5 @@ let value: TriggerInputTokens = { | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `type` | [models.EditTypeInputTokens](../models/edittypeinputtokens.mdx) | :heavy_check_mark: | N/A | +| `type` | [models.EditTypeInputTokens](../models/edittypeinputtokens) | :heavy_check_mark: | N/A | | `value` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/unifiedbenchmarksaaitem.mdx b/docs/models/unifiedbenchmarksaaitem.mdx index e73804a02..b53a339ff 100644 --- a/docs/models/unifiedbenchmarksaaitem.mdx +++ b/docs/models/unifiedbenchmarksaaitem.mdx @@ -30,5 +30,5 @@ let value: UnifiedBenchmarksAAItem = { | `displayName` | *string* | :heavy_check_mark: | Model name as listed on Artificial Analysis. | GPT-4o | | `intelligenceIndex` | *number* | :heavy_check_mark: | Artificial Analysis Intelligence Index composite score. Higher is better. | 71.2 | | `modelPermaslug` | *string* | :heavy_check_mark: | Stable OpenRouter model identifier. | openai/gpt-4o | -| `pricing` | [models.UnifiedBenchmarkPricing](../models/unifiedbenchmarkpricing.mdx) | :heavy_check_mark: | OpenRouter pricing per token for this model. Null if pricing is unavailable. | \{
"completion": "0.000015",
"prompt": "0.000003"
} | +| `pricing` | [models.UnifiedBenchmarkPricing](../models/unifiedbenchmarkpricing) | :heavy_check_mark: | OpenRouter pricing per token for this model. Null if pricing is unavailable. | \{
"completion": "0.000015",
"prompt": "0.000003"
} | | `source` | *"artificial-analysis"* | :heavy_check_mark: | Benchmark source discriminator. | | \ No newline at end of file diff --git a/docs/models/unifiedbenchmarksdaitem.mdx b/docs/models/unifiedbenchmarksdaitem.mdx index ad3f1843d..d9b24616c 100644 --- a/docs/models/unifiedbenchmarksdaitem.mdx +++ b/docs/models/unifiedbenchmarksdaitem.mdx @@ -40,7 +40,7 @@ let value: UnifiedBenchmarksDAItem = { | `displayName` | *string* | :heavy_check_mark: | Human-readable model name from Design Arena. | Claude Sonnet 4 | | `elo` | *number* | :heavy_check_mark: | ELO rating from head-to-head arena battles. | 1423 | | `modelPermaslug` | *string* | :heavy_check_mark: | Stable OpenRouter model identifier when mapped; otherwise the upstream Design Arena model id. | anthropic/claude-sonnet-4 | -| `pricing` | [models.UnifiedBenchmarkPricing](../models/unifiedbenchmarkpricing.mdx) | :heavy_check_mark: | OpenRouter pricing per token for this model. Null if pricing is unavailable. | \{
"completion": "0.000015",
"prompt": "0.000003"
} | +| `pricing` | [models.UnifiedBenchmarkPricing](../models/unifiedbenchmarkpricing) | :heavy_check_mark: | OpenRouter pricing per token for this model. Null if pricing is unavailable. | \{
"completion": "0.000015",
"prompt": "0.000003"
} | | `source` | *"design-arena"* | :heavy_check_mark: | Benchmark source discriminator. | | -| `tournamentStats` | [models.TournamentStats](../models/tournamentstats.mdx) | :heavy_check_mark: | Placement distribution from tournament matches. | | +| `tournamentStats` | [models.TournamentStats](../models/tournamentstats) | :heavy_check_mark: | Placement distribution from tournament matches. | | | `winRate` | *number* | :heavy_check_mark: | Win rate as a percentage (0–100). | 72 | \ No newline at end of file diff --git a/docs/models/unifiedbenchmarksmeta.mdx b/docs/models/unifiedbenchmarksmeta.mdx index 4f12d51fd..3be8c7471 100644 --- a/docs/models/unifiedbenchmarksmeta.mdx +++ b/docs/models/unifiedbenchmarksmeta.mdx @@ -26,7 +26,7 @@ let value: UnifiedBenchmarksMeta = { | `asOf` | *string* | :heavy_check_mark: | ISO-8601 timestamp of when this data was last updated. | 2026-06-03T12:00:00Z | | `citation` | *string* | :heavy_check_mark: | Required attribution when republishing this data, or null when results span multiple sources (attribute each item individually by its `source` discriminator). | Source: Artificial Analysis (artificialanalysis.ai) via OpenRouter (openrouter.ai/rankings). | | `modelCount` | *number* | :heavy_check_mark: | Number of unique models in the response. | | -| `source` | [models.SourceEnum](../models/sourceenum.mdx) | :heavy_check_mark: | The source filter applied, or null when all sources are returned. | artificial-analysis | +| `source` | [models.SourceEnum](../models/sourceenum) | :heavy_check_mark: | The source filter applied, or null when all sources are returned. | artificial-analysis | | `sourceUrl` | *string* | :heavy_check_mark: | URL of the upstream data source, or null when results span multiple sources. | https://artificialanalysis.ai | | `taskType` | *string* | :heavy_check_mark: | The task_type filter applied, or null if showing all. | | -| `version` | [models.UnifiedBenchmarksMetaVersion](../models/unifiedbenchmarksmetaversion.mdx) | :heavy_check_mark: | Dataset version. | | \ No newline at end of file +| `version` | [models.UnifiedBenchmarksMetaVersion](../models/unifiedbenchmarksmetaversion) | :heavy_check_mark: | Dataset version. | | \ No newline at end of file diff --git a/docs/models/unifiedbenchmarksoritem.mdx b/docs/models/unifiedbenchmarksoritem.mdx index a4906b7f7..19ec3e216 100644 --- a/docs/models/unifiedbenchmarksoritem.mdx +++ b/docs/models/unifiedbenchmarksoritem.mdx @@ -27,7 +27,7 @@ let value: UnifiedBenchmarksORItem = { | `accuracy` | *number* | :heavy_check_mark: | Aggregate accuracy score from 0 to 1. Higher is better. | 0.72 | | `accuracyStddev` | *number* | :heavy_check_mark: | Standard deviation of run accuracy, or null for a single run. | 0.03 | | `avgCostPerTask` | *number* | :heavy_check_mark: | Average cost per task in USD, or null if unavailable. | 0.002 | -| `benchmarkType` | [models.BenchmarkType](../models/benchmarktype.mdx) | :heavy_check_mark: | OpenRouter benchmark evaluation type. | gpqa_diamond | +| `benchmarkType` | [models.BenchmarkType](../models/benchmarktype) | :heavy_check_mark: | OpenRouter benchmark evaluation type. | gpqa_diamond | | `displayName` | *string* | :heavy_check_mark: | Human-readable model name. | GPT-4o | | `lastRunTimestamp` | *string* | :heavy_check_mark: | Timestamp of the most recent public benchmark run. | 2026-06-03T12:00:00Z | | `modelPermaslug` | *string* | :heavy_check_mark: | Stable OpenRouter model identifier. | openai/gpt-4o | diff --git a/docs/models/unifiedbenchmarksresponse.mdx b/docs/models/unifiedbenchmarksresponse.mdx index 7c066a570..1b76f3002 100644 --- a/docs/models/unifiedbenchmarksresponse.mdx +++ b/docs/models/unifiedbenchmarksresponse.mdx @@ -50,4 +50,4 @@ let value: UnifiedBenchmarksResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `data` | *models.UnifiedBenchmarksResponseData*[] | :heavy_check_mark: | N/A | | -| `meta` | [models.UnifiedBenchmarksMeta](../models/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 +| `meta` | [models.UnifiedBenchmarksMeta](../models/unifiedbenchmarksmeta) | :heavy_check_mark: | N/A | \{
"as_of": "2026-06-03T12:00:00Z",
"citation": "Source: Artificial Analysis (artificialanalysis.ai) via OpenRouter (openrouter.ai/rankings).",
"model_count": 50,
"source": "artificial-analysis",
"source_url": "https://artificialanalysis.ai",
"task_type": null,
"version": "v1"
} | \ No newline at end of file diff --git a/docs/models/updatebyokkeyresponse.mdx b/docs/models/updatebyokkeyresponse.mdx index a173c785a..9444028b5 100644 --- a/docs/models/updatebyokkeyresponse.mdx +++ b/docs/models/updatebyokkeyresponse.mdx @@ -28,4 +28,4 @@ let value: UpdateBYOKKeyResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [models.BYOKKey](../models/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",
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_fallback": 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` | [models.BYOKKey](../models/byokkey) | :heavy_check_mark: | N/A | \{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_fallback": false,
"label": "sk-...AbCd",
"name": "Production OpenAI Key",
"provider": "openai",
"sort_order": 0,
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/updateguardrailrequest.mdx b/docs/models/updateguardrailrequest.mdx index f768e50ee..ae0c52930 100644 --- a/docs/models/updateguardrailrequest.mdx +++ b/docs/models/updateguardrailrequest.mdx @@ -16,8 +16,8 @@ let value: UpdateGuardrailRequest = {}; | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `allowedModels` | *string*[] | :heavy_minus_sign: | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2"
] | | `allowedProviders` | *string*[] | :heavy_minus_sign: | New list of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | -| `contentFilterBuiltins` | [models.ContentFilterBuiltinEntryInput](../models/contentfilterbuiltinentryinput.mdx)[] | :heavy_minus_sign: | Builtin content filters to apply. Set to null to remove. Every builtin slug supports "block", "redact", and the detect-only "flag" action. | [
\{
"action": "block",
"slug": "regex-prompt-injection"
}
] | -| `contentFilters` | [models.ContentFilterEntry](../models/contentfilterentry.mdx)[] | :heavy_minus_sign: | Custom regex content filters to apply. Set to null to remove. | null | +| `contentFilterBuiltins` | [models.ContentFilterBuiltinEntryInput](../models/contentfilterbuiltinentryinput)[] | :heavy_minus_sign: | Builtin content filters to apply. Set to null to remove. Every builtin slug supports "block", "redact", and the detect-only "flag" action. | [
\{
"action": "block",
"slug": "regex-prompt-injection"
}
] | +| `contentFilters` | [models.ContentFilterEntry](../models/contentfilterentry)[] | :heavy_minus_sign: | Custom regex content filters to apply. Set to null to remove. | null | | `description` | *string* | :heavy_minus_sign: | New description for the guardrail | Updated description | | `enableFreeModelPublication` | *boolean* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that publish prompts. | false | | `enableFreeModelTraining` | *boolean* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that train on request data. | true | @@ -33,4 +33,4 @@ let value: UpdateGuardrailRequest = {}; | `includeByokInBudgets` | *boolean* | :heavy_minus_sign: | Whether BYOK (bring-your-own-key) inference spend counts toward this guardrail's limit_usd, in addition to OpenRouter credit spend. Omit to leave unchanged. | true | | `limitUsd` | *number* | :heavy_minus_sign: | New spending limit in USD | 75 | | `name` | *string* | :heavy_minus_sign: | New name for the guardrail | Updated Guardrail Name | -| `resetInterval` | [models.GuardrailInterval](../models/guardrailinterval.mdx) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | \ No newline at end of file +| `resetInterval` | [models.GuardrailInterval](../models/guardrailinterval) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | \ No newline at end of file diff --git a/docs/models/updateguardrailresponse.mdx b/docs/models/updateguardrailresponse.mdx index b5c0af5db..98bf81439 100644 --- a/docs/models/updateguardrailresponse.mdx +++ b/docs/models/updateguardrailresponse.mdx @@ -22,4 +22,4 @@ let value: UpdateGuardrailResponse = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.Guardrail](../models/guardrail.mdx) | :heavy_check_mark: | N/A | \{
"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` | [models.Guardrail](../models/guardrail) | :heavy_check_mark: | N/A | \{
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"google"
],
"content_filter_builtins": [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
],
"content_filters": null,
"created_at": "2025-08-24T10:30:00Z",
"description": "Guardrail for production environment",
"enable_free_model_publication": false,
"enable_free_model_training": true,
"enable_paid_model_training": true,
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"include_byok_in_budgets": false,
"limit_usd": 100,
"name": "Production Guardrail",
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file diff --git a/docs/models/updateobservabilitydestinationrequest.mdx b/docs/models/updateobservabilitydestinationrequest.mdx index 2dcda0940..e4dc94504 100644 --- a/docs/models/updateobservabilitydestinationrequest.mdx +++ b/docs/models/updateobservabilitydestinationrequest.mdx @@ -17,7 +17,7 @@ let value: UpdateObservabilityDestinationRequest = {}; | `apiKeyHashes` | *string*[] | :heavy_minus_sign: | Optional allowlist of OpenRouter API key hashes. `null` clears the filter (all keys). Omitting leaves the current value. Must contain at least one hash if provided. | null | | `config` | Record\ | :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` | *boolean* | :heavy_minus_sign: | Whether the destination is enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfigNullable](../models/observabilityfilterrulesconfignullable.mdx) | :heavy_minus_sign: | N/A | null | +| `filterRules` | [models.ObservabilityFilterRulesConfigNullable](../models/observabilityfilterrulesconfignullable) | :heavy_minus_sign: | N/A | null | | `name` | *string* | :heavy_minus_sign: | Human-readable name for the destination. | Production Langfuse | | `privacyMode` | *boolean* | :heavy_minus_sign: | When true, request/response bodies are not forwarded — only metadata. | false | | `samplingRate` | *number* | :heavy_minus_sign: | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | \ No newline at end of file diff --git a/docs/models/updateworkspaceresponse.mdx b/docs/models/updateworkspaceresponse.mdx index 7ad4fac6c..a6993a75b 100644 --- a/docs/models/updateworkspaceresponse.mdx +++ b/docs/models/updateworkspaceresponse.mdx @@ -33,4 +33,4 @@ let value: UpdateWorkspaceResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.Workspace](../models/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",
"id": "550e8400-e29b-41d4-a716-446655440000",
"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` | [models.Workspace](../models/workspace) | :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",
"id": "550e8400-e29b-41d4-a716-446655440000",
"io_logging_api_key_ids": null,
"io_logging_sampling_rate": 1,
"is_data_discount_logging_enabled": true,
"is_observability_broadcast_enabled": false,
"is_observability_io_logging_enabled": false,
"name": "Production",
"slug": "production",
"updated_at": "2025-08-24T15:45:00Z"
} | \ No newline at end of file diff --git a/docs/models/upsertworkspacebudgetresponse.mdx b/docs/models/upsertworkspacebudgetresponse.mdx index 340a6503c..82853b206 100644 --- a/docs/models/upsertworkspacebudgetresponse.mdx +++ b/docs/models/upsertworkspacebudgetresponse.mdx @@ -23,4 +23,4 @@ let value: UpsertWorkspaceBudgetResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.WorkspaceBudget](../models/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"
} | \ No newline at end of file +| `data` | [models.WorkspaceBudget](../models/workspacebudget) | :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"
} | \ No newline at end of file diff --git a/docs/models/usage.mdx b/docs/models/usage.mdx index 9eb96b1b5..e9b27d2bc 100644 --- a/docs/models/usage.mdx +++ b/docs/models/usage.mdx @@ -25,11 +25,11 @@ let value: Usage = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | | `inputTokens` | *number* | :heavy_check_mark: | N/A | | -| `inputTokensDetails` | [models.InputTokensDetails](../models/inputtokensdetails.mdx) | :heavy_check_mark: | N/A | | +| `inputTokensDetails` | [models.InputTokensDetails](../models/inputtokensdetails) | :heavy_check_mark: | N/A | | | `outputTokens` | *number* | :heavy_check_mark: | N/A | | -| `outputTokensDetails` | [models.OutputTokensDetails](../models/outputtokensdetails.mdx) | :heavy_check_mark: | N/A | | +| `outputTokensDetails` | [models.OutputTokensDetails](../models/outputtokensdetails) | :heavy_check_mark: | N/A | | | `totalTokens` | *number* | :heavy_check_mark: | N/A | | | `cost` | *number* | :heavy_minus_sign: | Cost of the completion | | -| `costDetails` | [models.UsageCostDetails](../models/usagecostdetails.mdx) | :heavy_minus_sign: | N/A | | +| `costDetails` | [models.UsageCostDetails](../models/usagecostdetails) | :heavy_minus_sign: | N/A | | | `isByok` | *boolean* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `serverToolUseDetails` | [models.ServerToolUseDetails](../models/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 +| `serverToolUseDetails` | [models.ServerToolUseDetails](../models/servertoolusedetails) | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | \{
"tool_calls_executed": 2,
"tool_calls_requested": 2,
"web_search_requests": 2
} | \ No newline at end of file diff --git a/docs/models/userlocation.mdx b/docs/models/userlocation.mdx index a7fb9f4d0..25b9aabe6 100644 --- a/docs/models/userlocation.mdx +++ b/docs/models/userlocation.mdx @@ -22,4 +22,4 @@ let value: UserLocation = { | `country` | *string* | :heavy_minus_sign: | N/A | | `region` | *string* | :heavy_minus_sign: | N/A | | `timezone` | *string* | :heavy_minus_sign: | N/A | -| `type` | [models.WebSearchPluginType](../models/websearchplugintype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.WebSearchPluginType](../models/websearchplugintype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/videogenerationrequest.mdx b/docs/models/videogenerationrequest.mdx index 92f685b42..562468286 100644 --- a/docs/models/videogenerationrequest.mdx +++ b/docs/models/videogenerationrequest.mdx @@ -16,15 +16,15 @@ let value: VideoGenerationRequest = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `aspectRatio` | [models.VideoGenerationRequestAspectRatio](../models/videogenerationrequestaspectratio.mdx) | :heavy_minus_sign: | Aspect ratio of the generated video | 16:9 | +| `aspectRatio` | [models.VideoGenerationRequestAspectRatio](../models/videogenerationrequestaspectratio) | :heavy_minus_sign: | Aspect ratio of the generated video | 16:9 | | `callbackUrl` | *string* | :heavy_minus_sign: | URL to receive a webhook notification when the video generation job completes. Overrides the workspace-level default callback URL if set. Must be HTTPS. | https://example.com/webhook | | `duration` | *number* | :heavy_minus_sign: | Duration of the generated video in seconds | 8 | -| `frameImages` | [models.FrameImage](../models/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. | | +| `frameImages` | [models.FrameImage](../models/frameimage)[] | :heavy_minus_sign: | Images to use as the first and/or last frame of the generated video. Each image must specify a frame_type of first_frame or last_frame. | | | `generateAudio` | *boolean* | :heavy_minus_sign: | Whether to generate audio alongside the video. Defaults to the endpoint's generate_audio capability flag, false if not set. | true | | `inputReferences` | *models.InputReference*[] | :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 (currently BytePlus Seedance 2.0); other providers use image references and ignore the rest. | | | `model` | *string* | :heavy_check_mark: | N/A | | | `prompt` | *string* | :heavy_minus_sign: | Text prompt describing the video to generate. Optional for models that support generating a video from image input alone; required by all other models. | A serene mountain landscape at sunset | -| `provider` | [models.VideoGenerationRequestProvider](../models/videogenerationrequestprovider.mdx) | :heavy_minus_sign: | Provider-specific passthrough configuration | | -| `resolution` | [models.VideoGenerationRequestResolution](../models/videogenerationrequestresolution.mdx) | :heavy_minus_sign: | Resolution of the generated video | 720p | +| `provider` | [models.VideoGenerationRequestProvider](../models/videogenerationrequestprovider) | :heavy_minus_sign: | Provider-specific passthrough configuration | | +| `resolution` | [models.VideoGenerationRequestResolution](../models/videogenerationrequestresolution) | :heavy_minus_sign: | Resolution of the generated video | 720p | | `seed` | *number* | :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. | | | `size` | *string* | :heavy_minus_sign: | Exact pixel dimensions of the generated video in "WIDTHxHEIGHT" format (e.g. "1280x720"). Interchangeable with resolution + aspect_ratio. | 1280x720 | \ No newline at end of file diff --git a/docs/models/videogenerationrequestprovider.mdx b/docs/models/videogenerationrequestprovider.mdx index a016e25a7..be2d43cd0 100644 --- a/docs/models/videogenerationrequestprovider.mdx +++ b/docs/models/videogenerationrequestprovider.mdx @@ -16,4 +16,4 @@ let value: VideoGenerationRequestProvider = {}; | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `options` | [models.VideoGenerationRequestOptions](../models/videogenerationrequestoptions.mdx) | :heavy_minus_sign: | N/A | \{
"google-vertex": \{
"output_config": \{
"effort": "low"
}
}
} | \ No newline at end of file +| `options` | [models.VideoGenerationRequestOptions](../models/videogenerationrequestoptions) | :heavy_minus_sign: | N/A | \{
"google-vertex": \{
"output_config": \{
"effort": "low"
}
}
} | \ No newline at end of file diff --git a/docs/models/videogenerationresponse.mdx b/docs/models/videogenerationresponse.mdx index 46630d91c..2f7791d52 100644 --- a/docs/models/videogenerationresponse.mdx +++ b/docs/models/videogenerationresponse.mdx @@ -22,6 +22,6 @@ let value: VideoGenerationResponse = { | `generationId` | *string* | :heavy_minus_sign: | The generation ID associated with this video generation job. Available once the job has been processed. | | | `id` | *string* | :heavy_check_mark: | N/A | | | `pollingUrl` | *string* | :heavy_check_mark: | N/A | | -| `status` | [models.VideoGenerationResponseStatus](../models/videogenerationresponsestatus.mdx) | :heavy_check_mark: | N/A | | +| `status` | [models.VideoGenerationResponseStatus](../models/videogenerationresponsestatus) | :heavy_check_mark: | N/A | | | `unsignedUrls` | *string*[] | :heavy_minus_sign: | N/A | | -| `usage` | [models.VideoGenerationUsage](../models/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 +| `usage` | [models.VideoGenerationUsage](../models/videogenerationusage) | :heavy_minus_sign: | Usage and cost information for the video generation. Available once the job has completed. | \{
"cost": 0.5,
"is_byok": false
} | \ No newline at end of file diff --git a/docs/models/videomodel.mdx b/docs/models/videomodel.mdx index 2771d5f35..340d6939a 100644 --- a/docs/models/videomodel.mdx +++ b/docs/models/videomodel.mdx @@ -47,8 +47,8 @@ let value: VideoModel = { | `name` | *string* | :heavy_check_mark: | Display name of the model | GPT-4 | | `pricingSkus` | Record\ | :heavy_minus_sign: | Pricing SKUs with provider prefix stripped, values as strings | | | `seed` | *boolean* | :heavy_check_mark: | Whether the model supports deterministic generation via seed parameter | | -| `supportedAspectRatios` | [models.SupportedAspectRatio](../models/supportedaspectratio.mdx)[] | :heavy_check_mark: | Supported output aspect ratios | | +| `supportedAspectRatios` | [models.SupportedAspectRatio](../models/supportedaspectratio)[] | :heavy_check_mark: | Supported output aspect ratios | | | `supportedDurations` | *number*[] | :heavy_check_mark: | Supported video durations in seconds | | -| `supportedFrameImages` | [models.SupportedFrameImage](../models/supportedframeimage.mdx)[] | :heavy_check_mark: | Supported frame image types (e.g. first_frame, last_frame) | | -| `supportedResolutions` | [models.SupportedResolution](../models/supportedresolution.mdx)[] | :heavy_check_mark: | Supported output resolutions | | -| `supportedSizes` | [models.SupportedSize](../models/supportedsize.mdx)[] | :heavy_check_mark: | Supported output sizes (width x height) | | \ No newline at end of file +| `supportedFrameImages` | [models.SupportedFrameImage](../models/supportedframeimage)[] | :heavy_check_mark: | Supported frame image types (e.g. first_frame, last_frame) | | +| `supportedResolutions` | [models.SupportedResolution](../models/supportedresolution)[] | :heavy_check_mark: | Supported output resolutions | | +| `supportedSizes` | [models.SupportedSize](../models/supportedsize)[] | :heavy_check_mark: | Supported output sizes (width x height) | | \ No newline at end of file diff --git a/docs/models/videomodelslistresponse.mdx b/docs/models/videomodelslistresponse.mdx index 9f039040d..6c31f8286 100644 --- a/docs/models/videomodelslistresponse.mdx +++ b/docs/models/videomodelslistresponse.mdx @@ -41,4 +41,4 @@ let value: VideoModelsListResponse = { | Field | Type | Required | Description | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `data` | [models.VideoModel](../models/videomodel.mdx)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [models.VideoModel](../models/videomodel)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/webfetchservertool.mdx b/docs/models/webfetchservertool.mdx index 7d62758af..02f5939d5 100644 --- a/docs/models/webfetchservertool.mdx +++ b/docs/models/webfetchservertool.mdx @@ -18,5 +18,5 @@ let value: WebFetchServerTool = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `parameters` | [models.WebFetchServerToolConfig](../models/webfetchservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:web_fetch server tool | \{
"max_content_tokens": 100000,
"max_uses": 10
} | -| `type` | [models.WebFetchServerToolType](../models/webfetchservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.WebFetchServerToolConfig](../models/webfetchservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:web_fetch server tool | \{
"max_content_tokens": 100000,
"max_uses": 10
} | +| `type` | [models.WebFetchServerToolType](../models/webfetchservertooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/webfetchservertoolconfig.mdx b/docs/models/webfetchservertoolconfig.mdx index b833a602c..fa49b2c8b 100644 --- a/docs/models/webfetchservertoolconfig.mdx +++ b/docs/models/webfetchservertoolconfig.mdx @@ -18,6 +18,6 @@ let value: WebFetchServerToolConfig = {}; | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `allowedDomains` | *string*[] | :heavy_minus_sign: | Only fetch from these domains. | | | `blockedDomains` | *string*[] | :heavy_minus_sign: | Never fetch from these domains. | | -| `engine` | [models.WebFetchEngineEnum](../models/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 | +| `engine` | [models.WebFetchEngineEnum](../models/webfetchengineenum) | :heavy_minus_sign: | Which fetch engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in fetch. "exa" uses Exa Contents API. "openrouter" uses direct HTTP fetch. "firecrawl" uses Firecrawl scrape (requires BYOK). "parallel" uses the Parallel extract API. | auto | | `maxContentTokens` | *number* | :heavy_minus_sign: | Maximum content length in approximate tokens. Content exceeding this limit is truncated. | 100000 | | `maxUses` | *number* | :heavy_minus_sign: | Maximum number of web fetches per request. Once exceeded, the tool returns an error. | 10 | \ No newline at end of file diff --git a/docs/models/websearchconfig.mdx b/docs/models/websearchconfig.mdx index 3b64249df..27093428b 100644 --- a/docs/models/websearchconfig.mdx +++ b/docs/models/websearchconfig.mdx @@ -15,11 +15,11 @@ let value: WebSearchConfig = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `allowedDomains` | *string*[] | :heavy_minus_sign: | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, and most native providers (Anthropic, OpenAI, xAI). Cannot be used with excluded_domains. | | -| `engine` | [models.WebSearchEngineEnum](../models/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 | +| `engine` | [models.WebSearchEngineEnum](../models/websearchengineenum) | :heavy_minus_sign: | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | | `excludedDomains` | *string*[] | :heavy_minus_sign: | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, OpenAI, and xAI. Cannot be used with allowed_domains. | | | `maxCharacters` | *number* | :heavy_minus_sign: | Exact maximum number of characters of content per search result. Applies to the Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, caps highlight content per result. For Parallel, caps excerpt content per result (default 1,500 when omitted). For Perplexity, maps to the native `max_tokens_per_page` parameter (converted from characters to tokens) and trims the response to the exact character cap. When both `max_characters` and `search_context_size` are set, `max_characters` takes precedence. When omitted, falls back to `search_context_size` mapping (Exa) or engine defaults (Parallel, Perplexity). | 2000 | | `maxResults` | *number* | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | | `maxTotalResults` | *number* | :heavy_minus_sign: | Maximum total number of search results across all search calls in a single request. Once this limit is reached, the tool will stop returning new results. Useful for controlling cost and context size in agentic loops. Defaults to 50 when not specified. | 50 | | `maxUses` | *number* | :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 | -| `searchContextSize` | [models.SearchQualityLevel](../models/searchqualitylevel.mdx) | :heavy_minus_sign: | How much context to retrieve per result. Applies to Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, pins a fixed per-result character cap (low=5,000, medium=15,000, high=30,000); when omitted, Exa picks an adaptive size per query and document (typically ~2,000–4,000 characters per result). For Parallel, controls the total characters across all results; when omitted, Parallel uses its own default size. For Perplexity, maps directly to the Search API's native search_context_size parameter. Overridden by `max_characters` when both are set. | medium | -| `userLocation` | [models.WebSearchUserLocationServerTool](../models/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"
} | \ No newline at end of file +| `searchContextSize` | [models.SearchQualityLevel](../models/searchqualitylevel) | :heavy_minus_sign: | How much context to retrieve per result. Applies to Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, pins a fixed per-result character cap (low=5,000, medium=15,000, high=30,000); when omitted, Exa picks an adaptive size per query and document (typically ~2,000–4,000 characters per result). For Parallel, controls the total characters across all results; when omitted, Parallel uses its own default size. For Perplexity, maps directly to the Search API's native search_context_size parameter. Overridden by `max_characters` when both are set. | medium | +| `userLocation` | [models.WebSearchUserLocationServerTool](../models/websearchuserlocationservertool) | :heavy_minus_sign: | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file diff --git a/docs/models/websearchplugin.mdx b/docs/models/websearchplugin.mdx index 7edbd9397..5e4dd730b 100644 --- a/docs/models/websearchplugin.mdx +++ b/docs/models/websearchplugin.mdx @@ -17,11 +17,11 @@ let value: WebSearchPlugin = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `enabled` | *boolean* | :heavy_minus_sign: | Set to false to disable the web-search plugin for this request. Defaults to true. | | -| `engine` | [models.WebSearchEngine](../models/websearchengine.mdx) | :heavy_minus_sign: | The search engine to use for web search. | exa | +| `engine` | [models.WebSearchEngine](../models/websearchengine) | :heavy_minus_sign: | The search engine to use for web search. | exa | | `excludeDomains` | *string*[] | :heavy_minus_sign: | A list of domains to exclude from web search results. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog"). | [
"example.com",
"*.substack.com",
"openai.com/blog"
] | | `id` | *"web"* | :heavy_check_mark: | N/A | | | `includeDomains` | *string*[] | :heavy_minus_sign: | A list of domains to restrict web search results to. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog"). | [
"example.com",
"*.substack.com",
"openai.com/blog"
] | | `maxResults` | *number* | :heavy_minus_sign: | N/A | | | `maxUses` | *number* | :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). | | | `searchPrompt` | *string* | :heavy_minus_sign: | N/A | | -| `userLocation` | [models.UserLocation](../models/userlocation.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 +| `userLocation` | [models.UserLocation](../models/userlocation) | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file diff --git a/docs/models/websearchservertool.mdx b/docs/models/websearchservertool.mdx index be902a0d0..c38aec221 100644 --- a/docs/models/websearchservertool.mdx +++ b/docs/models/websearchservertool.mdx @@ -18,10 +18,10 @@ let value: WebSearchServerTool = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `engine` | [models.WebSearchEngineEnum](../models/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` | [models.WebSearchDomainFilter](../models/websearchdomainfilter.mdx) | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | +| `engine` | [models.WebSearchEngineEnum](../models/websearchengineenum) | :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` | [models.WebSearchDomainFilter](../models/websearchdomainfilter) | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | | `maxResults` | *number* | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | | `maxUses` | *number* | :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 | -| `searchContextSize` | [models.SearchContextSizeEnum](../models/searchcontextsizeenum.mdx) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `type` | [models.WebSearchServerToolType](../models/websearchservertooltype.mdx) | :heavy_check_mark: | N/A | | -| `userLocation` | [models.WebSearchUserLocation](../models/websearchuserlocation.mdx) | :heavy_minus_sign: | User location information for web search | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file +| `searchContextSize` | [models.SearchContextSizeEnum](../models/searchcontextsizeenum) | :heavy_minus_sign: | Size of the search context for web search tools | medium | +| `type` | [models.WebSearchServerToolType](../models/websearchservertooltype) | :heavy_check_mark: | N/A | | +| `userLocation` | [models.WebSearchUserLocation](../models/websearchuserlocation) | :heavy_minus_sign: | User location information for web search | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file diff --git a/docs/models/websearchservertoolconfig.mdx b/docs/models/websearchservertoolconfig.mdx index 7d8ebb69f..bc8737b0b 100644 --- a/docs/models/websearchservertoolconfig.mdx +++ b/docs/models/websearchservertoolconfig.mdx @@ -17,11 +17,11 @@ let value: WebSearchServerToolConfig = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `allowedDomains` | *string*[] | :heavy_minus_sign: | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, and most native providers (Anthropic, OpenAI, xAI). Cannot be used with excluded_domains. | | -| `engine` | [models.WebSearchEngineEnum](../models/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 | +| `engine` | [models.WebSearchEngineEnum](../models/websearchengineenum) | :heavy_minus_sign: | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | | `excludedDomains` | *string*[] | :heavy_minus_sign: | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, OpenAI, and xAI. Cannot be used with allowed_domains. | | | `maxCharacters` | *number* | :heavy_minus_sign: | Exact maximum number of characters of content per search result. Applies to the Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, caps highlight content per result. For Parallel, caps excerpt content per result (default 1,500 when omitted). For Perplexity, maps to the native `max_tokens_per_page` parameter (converted from characters to tokens) and trims the response to the exact character cap. When both `max_characters` and `search_context_size` are set, `max_characters` takes precedence. When omitted, falls back to `search_context_size` mapping (Exa) or engine defaults (Parallel, Perplexity). | 2000 | | `maxResults` | *number* | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | | `maxTotalResults` | *number* | :heavy_minus_sign: | Maximum total number of search results across all search calls in a single request. Once this limit is reached, the tool will stop returning new results. Useful for controlling cost and context size in agentic loops. Defaults to 50 when not specified. | 50 | | `maxUses` | *number* | :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 | -| `searchContextSize` | [models.SearchQualityLevel](../models/searchqualitylevel.mdx) | :heavy_minus_sign: | How much context to retrieve per result. Applies to Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, pins a fixed per-result character cap (low=5,000, medium=15,000, high=30,000); when omitted, Exa picks an adaptive size per query and document (typically ~2,000–4,000 characters per result). For Parallel, controls the total characters across all results; when omitted, Parallel uses its own default size. For Perplexity, maps directly to the Search API's native search_context_size parameter. Overridden by `max_characters` when both are set. | medium | -| `userLocation` | [models.WebSearchUserLocationServerTool](../models/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"
} | \ No newline at end of file +| `searchContextSize` | [models.SearchQualityLevel](../models/searchqualitylevel) | :heavy_minus_sign: | How much context to retrieve per result. Applies to Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, pins a fixed per-result character cap (low=5,000, medium=15,000, high=30,000); when omitted, Exa picks an adaptive size per query and document (typically ~2,000–4,000 characters per result). For Parallel, controls the total characters across all results; when omitted, Parallel uses its own default size. For Perplexity, maps directly to the Search API's native search_context_size parameter. Overridden by `max_characters` when both are set. | medium | +| `userLocation` | [models.WebSearchUserLocationServerTool](../models/websearchuserlocationservertool) | :heavy_minus_sign: | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file diff --git a/docs/models/websearchservertoolopenrouter.mdx b/docs/models/websearchservertoolopenrouter.mdx index b991be011..37952fcc2 100644 --- a/docs/models/websearchservertoolopenrouter.mdx +++ b/docs/models/websearchservertoolopenrouter.mdx @@ -18,5 +18,5 @@ let value: WebSearchServerToolOpenRouter = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `parameters` | [models.WebSearchServerToolConfig](../models/websearchservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:web_search server tool | \{
"max_results": 5,
"search_context_size": "medium"
} | -| `type` | [models.WebSearchServerToolOpenRouterType](../models/websearchservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.WebSearchServerToolConfig](../models/websearchservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:web_search server tool | \{
"max_results": 5,
"search_context_size": "medium"
} | +| `type` | [models.WebSearchServerToolOpenRouterType](../models/websearchservertoolopenroutertype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/websearchsource.mdx b/docs/models/websearchsource.mdx index a59301bf3..eba10d9e4 100644 --- a/docs/models/websearchsource.mdx +++ b/docs/models/websearchsource.mdx @@ -17,5 +17,5 @@ let value: WebSearchSource = { | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `type` | [models.WebSearchSourceType](../models/websearchsourcetype.mdx) | :heavy_check_mark: | N/A | +| `type` | [models.WebSearchSourceType](../models/websearchsourcetype) | :heavy_check_mark: | N/A | | `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/websearchuserlocation.mdx b/docs/models/websearchuserlocation.mdx index 6f42bfa73..e989989c0 100644 --- a/docs/models/websearchuserlocation.mdx +++ b/docs/models/websearchuserlocation.mdx @@ -20,4 +20,4 @@ let value: WebSearchUserLocation = {}; | `country` | *string* | :heavy_minus_sign: | N/A | | `region` | *string* | :heavy_minus_sign: | N/A | | `timezone` | *string* | :heavy_minus_sign: | N/A | -| `type` | [models.WebSearchUserLocationType](../models/websearchuserlocationtype.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | [models.WebSearchUserLocationType](../models/websearchuserlocationtype) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/websearchuserlocationservertool.mdx b/docs/models/websearchuserlocationservertool.mdx index b0a75851b..a15acd422 100644 --- a/docs/models/websearchuserlocationservertool.mdx +++ b/docs/models/websearchuserlocationservertool.mdx @@ -20,4 +20,4 @@ let value: WebSearchUserLocationServerTool = {}; | `country` | *string* | :heavy_minus_sign: | N/A | | `region` | *string* | :heavy_minus_sign: | N/A | | `timezone` | *string* | :heavy_minus_sign: | N/A | -| `type` | [models.WebSearchUserLocationServerToolType](../models/websearchuserlocationservertooltype.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | [models.WebSearchUserLocationServerToolType](../models/websearchuserlocationservertooltype) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/workspacebudget.mdx b/docs/models/workspacebudget.mdx index f8867c7d9..fb8a75c4c 100644 --- a/docs/models/workspacebudget.mdx +++ b/docs/models/workspacebudget.mdx @@ -24,6 +24,6 @@ let value: WorkspaceBudget = { | `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the budget was created | 2025-08-24T10:30:00Z | | `id` | *string* | :heavy_check_mark: | Unique identifier for the budget | 770e8400-e29b-41d4-a716-446655440000 | | `limitUsd` | *number* | :heavy_check_mark: | Spending limit in USD for this interval | 100 | -| `resetInterval` | [models.ResetInterval](../models/resetinterval.mdx) | :heavy_check_mark: | Interval at which spend resets. Null means a lifetime (one-time) budget. | monthly | +| `resetInterval` | [models.ResetInterval](../models/resetinterval) | :heavy_check_mark: | Interval at which spend resets. Null means a lifetime (one-time) budget. | monthly | | `updatedAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the budget was last updated | 2025-08-24T15:45:00Z | | `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace the budget belongs to | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/workspacemember.mdx b/docs/models/workspacemember.mdx index 48e475165..e11801666 100644 --- a/docs/models/workspacemember.mdx +++ b/docs/models/workspacemember.mdx @@ -22,6 +22,6 @@ let value: WorkspaceMember = { | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | | `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the membership was created | 2025-08-24T10:30:00Z | | `id` | *string* | :heavy_check_mark: | Unique identifier for the workspace membership | 660e8400-e29b-41d4-a716-446655440000 | -| `role` | [models.WorkspaceMemberRole](../models/workspacememberrole.mdx) | :heavy_check_mark: | Role of the member in the workspace | member | +| `role` | [models.WorkspaceMemberRole](../models/workspacememberrole) | :heavy_check_mark: | Role of the member in the workspace | member | | `userId` | *string* | :heavy_check_mark: | Clerk user ID of the member | user_abc123 | | `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/sdks/analytics/README.mdx b/docs/sdks/analytics/README.mdx index 366a193e1..315dab7f9 100644 --- a/docs/sdks/analytics/README.mdx +++ b/docs/sdks/analytics/README.mdx @@ -70,14 +70,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetUserActivityRequest](../../models/operations/getuseractivityrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.GetUserActivityRequest](../../models/operations/getuseractivityrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.ActivityResponse](../../models/activityresponse.mdx)\>** +**Promise\<[models.ActivityResponse](../../models/activityresponse)\>** ### Errors diff --git a/docs/sdks/apikeys/README.mdx b/docs/sdks/apikeys/README.mdx index 6e0d73c44..82d13ab38 100644 --- a/docs/sdks/apikeys/README.mdx +++ b/docs/sdks/apikeys/README.mdx @@ -75,14 +75,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetCurrentKeyRequest](../../models/operations/getcurrentkeyrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.GetCurrentKeyRequest](../../models/operations/getcurrentkeyrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.GetCurrentKeyResponse](../../models/operations/getcurrentkeyresponse.mdx)\>** +**Promise\<[operations.GetCurrentKeyResponse](../../models/operations/getcurrentkeyresponse)\>** ### Errors @@ -151,14 +151,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListRequest](../../models/operations/listrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListRequest](../../models/operations/listrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.ListResponse](../../models/operations/listresponse.mdx)\>** +**Promise\<[operations.ListResponse](../../models/operations/listresponse)\>** ### Errors @@ -245,14 +245,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateKeysRequest](../../models/operations/createkeysrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.CreateKeysRequest](../../models/operations/createkeysrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.CreateKeysResponse](../../models/operations/createkeysresponse.mdx)\>** +**Promise\<[operations.CreateKeysResponse](../../models/operations/createkeysresponse)\>** ### Errors @@ -328,14 +328,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DeleteKeysRequest](../../models/operations/deletekeysrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.DeleteKeysRequest](../../models/operations/deletekeysrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.DeleteKeysResponse](../../models/operations/deletekeysresponse.mdx)\>** +**Promise\<[operations.DeleteKeysResponse](../../models/operations/deletekeysresponse)\>** ### Errors @@ -410,14 +410,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetKeyRequest](../../models/operations/getkeyrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.GetKeyRequest](../../models/operations/getkeyrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.GetKeyResponse](../../models/operations/getkeyresponse.mdx)\>** +**Promise\<[operations.GetKeyResponse](../../models/operations/getkeyresponse)\>** ### Errors @@ -506,14 +506,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.UpdateKeysRequest](../../models/operations/updatekeysrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.UpdateKeysRequest](../../models/operations/updatekeysrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.UpdateKeysResponse](../../models/operations/updatekeysresponse.mdx)\>** +**Promise\<[operations.UpdateKeysResponse](../../models/operations/updatekeysresponse)\>** ### Errors diff --git a/docs/sdks/benchmarks/README.mdx b/docs/sdks/benchmarks/README.mdx index 25b7b2fe8..d0e28356c 100644 --- a/docs/sdks/benchmarks/README.mdx +++ b/docs/sdks/benchmarks/README.mdx @@ -70,14 +70,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetBenchmarksRequest](../../models/operations/getbenchmarksrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.GetBenchmarksRequest](../../models/operations/getbenchmarksrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.UnifiedBenchmarksResponse](../../models/unifiedbenchmarksresponse.mdx)\>** +**Promise\<[models.UnifiedBenchmarksResponse](../../models/unifiedbenchmarksresponse)\>** ### Errors diff --git a/docs/sdks/betaanalytics/README.mdx b/docs/sdks/betaanalytics/README.mdx index 89b5f1850..c92f11ab2 100644 --- a/docs/sdks/betaanalytics/README.mdx +++ b/docs/sdks/betaanalytics/README.mdx @@ -71,14 +71,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetAnalyticsMetaRequest](../../models/operations/getanalyticsmetarequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.GetAnalyticsMetaRequest](../../models/operations/getanalyticsmetarequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.GetAnalyticsMetaResponse](../../models/operations/getanalyticsmetaresponse.mdx)\>** +**Promise\<[operations.GetAnalyticsMetaResponse](../../models/operations/getanalyticsmetaresponse)\>** ### Errors @@ -178,14 +178,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.QueryAnalyticsRequest](../../models/operations/queryanalyticsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.QueryAnalyticsRequest](../../models/operations/queryanalyticsrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.QueryAnalyticsResponse](../../models/operations/queryanalyticsresponse.mdx)\>** +**Promise\<[operations.QueryAnalyticsResponse](../../models/operations/queryanalyticsresponse)\>** ### Errors diff --git a/docs/sdks/betaresponses/README.mdx b/docs/sdks/betaresponses/README.mdx index 36034dd52..1bbfeb88b 100644 --- a/docs/sdks/betaresponses/README.mdx +++ b/docs/sdks/betaresponses/README.mdx @@ -128,14 +128,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateResponsesRequest](../../models/operations/createresponsesrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.CreateResponsesRequest](../../models/operations/createresponsesrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.CreateResponsesResponse](../../models/operations/createresponsesresponse.mdx)\>** +**Promise\<[operations.CreateResponsesResponse](../../models/operations/createresponsesresponse)\>** ### Errors diff --git a/docs/sdks/byok/README.mdx b/docs/sdks/byok/README.mdx index 391abd249..c6ea45e8c 100644 --- a/docs/sdks/byok/README.mdx +++ b/docs/sdks/byok/README.mdx @@ -78,14 +78,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListBYOKKeysRequest](../../models/operations/listbyokkeysrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListBYOKKeysRequest](../../models/operations/listbyokkeysrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.ListBYOKKeysResponse](../../models/operations/listbyokkeysresponse.mdx)\>** +**Promise\<[operations.ListBYOKKeysResponse](../../models/operations/listbyokkeysresponse)\>** ### Errors @@ -167,14 +167,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateBYOKKeyRequest](../../models/operations/createbyokkeyrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.CreateBYOKKeyRequest](../../models/operations/createbyokkeyrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.CreateBYOKKeyResponse](../../models/createbyokkeyresponse.mdx)\>** +**Promise\<[models.CreateBYOKKeyResponse](../../models/createbyokkeyresponse)\>** ### Errors @@ -249,14 +249,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DeleteBYOKKeyRequest](../../models/operations/deletebyokkeyrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.DeleteBYOKKeyRequest](../../models/operations/deletebyokkeyrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.DeleteBYOKKeyResponse](../../models/deletebyokkeyresponse.mdx)\>** +**Promise\<[models.DeleteBYOKKeyResponse](../../models/deletebyokkeyresponse)\>** ### Errors @@ -330,14 +330,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetBYOKKeyRequest](../../models/operations/getbyokkeyrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.GetBYOKKeyRequest](../../models/operations/getbyokkeyrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.GetBYOKKeyResponse](../../models/getbyokkeyresponse.mdx)\>** +**Promise\<[models.GetBYOKKeyResponse](../../models/getbyokkeyresponse)\>** ### Errors @@ -419,14 +419,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.UpdateBYOKKeyRequest](../../models/operations/updatebyokkeyrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.UpdateBYOKKeyRequest](../../models/operations/updatebyokkeyrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.UpdateBYOKKeyResponse](../../models/updatebyokkeyresponse.mdx)\>** +**Promise\<[models.UpdateBYOKKeyResponse](../../models/updatebyokkeyresponse)\>** ### Errors diff --git a/docs/sdks/chat/README.mdx b/docs/sdks/chat/README.mdx index e8d58be47..783bd369f 100644 --- a/docs/sdks/chat/README.mdx +++ b/docs/sdks/chat/README.mdx @@ -169,14 +169,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.SendChatCompletionRequestRequest](../../models/operations/sendchatcompletionrequestrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.SendChatCompletionRequestRequest](../../models/operations/sendchatcompletionrequestrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.SendChatCompletionRequestResponse](../../models/operations/sendchatcompletionrequestresponse.mdx)\>** +**Promise\<[operations.SendChatCompletionRequestResponse](../../models/operations/sendchatcompletionrequestresponse)\>** ### Errors diff --git a/docs/sdks/classifications/README.mdx b/docs/sdks/classifications/README.mdx index b81073c24..bd5fca399 100644 --- a/docs/sdks/classifications/README.mdx +++ b/docs/sdks/classifications/README.mdx @@ -88,14 +88,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetTaskClassificationsRequest](../../models/operations/gettaskclassificationsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.GetTaskClassificationsRequest](../../models/operations/gettaskclassificationsrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.TaskClassificationResponse](../../models/taskclassificationresponse.mdx)\>** +**Promise\<[models.TaskClassificationResponse](../../models/taskclassificationresponse)\>** ### Errors diff --git a/docs/sdks/credits/README.mdx b/docs/sdks/credits/README.mdx index 20b3a9f4b..3d7432dd8 100644 --- a/docs/sdks/credits/README.mdx +++ b/docs/sdks/credits/README.mdx @@ -70,14 +70,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetCreditsRequest](../../models/operations/getcreditsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.GetCreditsRequest](../../models/operations/getcreditsrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.GetCreditsResponse](../../models/operations/getcreditsresponse.mdx)\>** +**Promise\<[operations.GetCreditsResponse](../../models/operations/getcreditsresponse)\>** ### Errors diff --git a/docs/sdks/datasets/README.mdx b/docs/sdks/datasets/README.mdx index 760149842..6f5a263c9 100644 --- a/docs/sdks/datasets/README.mdx +++ b/docs/sdks/datasets/README.mdx @@ -97,14 +97,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetAppRankingsRequest](../../models/operations/getapprankingsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.GetAppRankingsRequest](../../models/operations/getapprankingsrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.GetAppRankingsResponse](../../models/operations/getapprankingsresponse.mdx)\>** +**Promise\<[operations.GetAppRankingsResponse](../../models/operations/getapprankingsresponse)\>** ### Errors @@ -200,14 +200,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetRankingsDailyRequest](../../models/operations/getrankingsdailyrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.GetRankingsDailyRequest](../../models/operations/getrankingsdailyrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.RankingsDailyResponse](../../models/rankingsdailyresponse.mdx)\>** +**Promise\<[models.RankingsDailyResponse](../../models/rankingsdailyresponse)\>** ### Errors diff --git a/docs/sdks/embeddings/README.mdx b/docs/sdks/embeddings/README.mdx index 134fcbc68..68c18fd91 100644 --- a/docs/sdks/embeddings/README.mdx +++ b/docs/sdks/embeddings/README.mdx @@ -81,14 +81,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateEmbeddingsRequest](../../models/operations/createembeddingsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.CreateEmbeddingsRequest](../../models/operations/createembeddingsrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.CreateEmbeddingsResponse](../../models/operations/createembeddingsresponse.mdx)\>** +**Promise\<[operations.CreateEmbeddingsResponse](../../models/operations/createembeddingsresponse)\>** ### Errors @@ -169,14 +169,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListEmbeddingsModelsRequest](../../models/operations/listembeddingsmodelsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListEmbeddingsModelsRequest](../../models/operations/listembeddingsmodelsrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.ListEmbeddingsModelsResponse](../../models/operations/listembeddingsmodelsresponse.mdx)\>** +**Promise\<[operations.ListEmbeddingsModelsResponse](../../models/operations/listembeddingsmodelsresponse)\>** ### Errors diff --git a/docs/sdks/endpoints/README.mdx b/docs/sdks/endpoints/README.mdx index 6629f1c02..0d517f2af 100644 --- a/docs/sdks/endpoints/README.mdx +++ b/docs/sdks/endpoints/README.mdx @@ -71,14 +71,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListEndpointsZdrRequest](../../models/operations/listendpointszdrrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListEndpointsZdrRequest](../../models/operations/listendpointszdrrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.ListEndpointsZdrResponse](../../models/operations/listendpointszdrresponse.mdx)\>** +**Promise\<[operations.ListEndpointsZdrResponse](../../models/operations/listendpointszdrresponse)\>** ### Errors @@ -153,14 +153,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListEndpointsRequest](../../models/operations/listendpointsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListEndpointsRequest](../../models/operations/listendpointsrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.ListEndpointsResponse](../../models/operations/listendpointsresponse.mdx)\>** +**Promise\<[operations.ListEndpointsResponse](../../models/operations/listendpointsresponse)\>** ### Errors diff --git a/docs/sdks/files/README.mdx b/docs/sdks/files/README.mdx index 874b6830f..15b246094 100644 --- a/docs/sdks/files/README.mdx +++ b/docs/sdks/files/README.mdx @@ -78,14 +78,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListFilesRequest](../../models/operations/listfilesrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListFilesRequest](../../models/operations/listfilesrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.ListFilesResponse](../../models/operations/listfilesresponse.mdx)\>** +**Promise\<[operations.ListFilesResponse](../../models/operations/listfilesresponse)\>** ### Errors @@ -171,14 +171,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.UploadFileRequest](../../models/operations/uploadfilerequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.UploadFileRequest](../../models/operations/uploadfilerequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.FileResponse](../../models/fileresponse.mdx)\>** +**Promise\<[models.FileResponse](../../models/fileresponse)\>** ### Errors @@ -259,14 +259,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DeleteFileRequest](../../models/operations/deletefilerequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.DeleteFileRequest](../../models/operations/deletefilerequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.FileDeleteResponse](../../models/filedeleteresponse.mdx)\>** +**Promise\<[models.FileDeleteResponse](../../models/filedeleteresponse)\>** ### Errors @@ -346,14 +346,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetFileMetadataRequest](../../models/operations/getfilemetadatarequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.GetFileMetadataRequest](../../models/operations/getfilemetadatarequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.FileResponse](../../models/fileresponse.mdx)\>** +**Promise\<[models.FileResponse](../../models/fileresponse)\>** ### Errors @@ -433,14 +433,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DownloadFileContentRequest](../../models/operations/downloadfilecontentrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.DownloadFileContentRequest](../../models/operations/downloadfilecontentrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[ReadableStream\](../../models/.mdx)\>** +**Promise\<[ReadableStream\](../../models/)\>** ### Errors diff --git a/docs/sdks/generations/README.mdx b/docs/sdks/generations/README.mdx index de912e710..8da545f71 100644 --- a/docs/sdks/generations/README.mdx +++ b/docs/sdks/generations/README.mdx @@ -76,14 +76,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetGenerationRequest](../../models/operations/getgenerationrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.GetGenerationRequest](../../models/operations/getgenerationrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.GenerationResponse](../../models/generationresponse.mdx)\>** +**Promise\<[models.GenerationResponse](../../models/generationresponse)\>** ### Errors @@ -162,14 +162,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListGenerationContentRequest](../../models/operations/listgenerationcontentrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListGenerationContentRequest](../../models/operations/listgenerationcontentrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.GenerationContentResponse](../../models/generationcontentresponse.mdx)\>** +**Promise\<[models.GenerationContentResponse](../../models/generationcontentresponse)\>** ### Errors @@ -256,14 +256,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.SubmitGenerationFeedbackRequest](../../models/operations/submitgenerationfeedbackrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.SubmitGenerationFeedbackRequest](../../models/operations/submitgenerationfeedbackrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.SubmitGenerationFeedbackResponse](../../models/submitgenerationfeedbackresponse.mdx)\>** +**Promise\<[models.SubmitGenerationFeedbackResponse](../../models/submitgenerationfeedbackresponse)\>** ### Errors diff --git a/docs/sdks/guardrails/README.mdx b/docs/sdks/guardrails/README.mdx index e58eca813..7024000e8 100644 --- a/docs/sdks/guardrails/README.mdx +++ b/docs/sdks/guardrails/README.mdx @@ -86,14 +86,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListGuardrailsRequest](../../models/operations/listguardrailsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListGuardrailsRequest](../../models/operations/listguardrailsrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.ListGuardrailsResponse](../../models/operations/listguardrailsresponse.mdx)\>** +**Promise\<[operations.ListGuardrailsResponse](../../models/operations/listguardrailsresponse)\>** ### Errors @@ -203,14 +203,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateGuardrailRequest](../../models/operations/createguardrailrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.CreateGuardrailRequest](../../models/operations/createguardrailrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.CreateGuardrailResponse](../../models/createguardrailresponse.mdx)\>** +**Promise\<[models.CreateGuardrailResponse](../../models/createguardrailresponse)\>** ### Errors @@ -285,14 +285,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DeleteGuardrailRequest](../../models/operations/deleteguardrailrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.DeleteGuardrailRequest](../../models/operations/deleteguardrailrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.DeleteGuardrailResponse](../../models/deleteguardrailresponse.mdx)\>** +**Promise\<[models.DeleteGuardrailResponse](../../models/deleteguardrailresponse)\>** ### Errors @@ -366,14 +366,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetGuardrailRequest](../../models/operations/getguardrailrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.GetGuardrailRequest](../../models/operations/getguardrailrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.GetGuardrailResponse](../../models/getguardrailresponse.mdx)\>** +**Promise\<[models.GetGuardrailResponse](../../models/getguardrailresponse)\>** ### Errors @@ -459,14 +459,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.UpdateGuardrailRequest](../../models/operations/updateguardrailrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.UpdateGuardrailRequest](../../models/operations/updateguardrailrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.UpdateGuardrailResponse](../../models/updateguardrailresponse.mdx)\>** +**Promise\<[models.UpdateGuardrailResponse](../../models/updateguardrailresponse)\>** ### Errors @@ -545,14 +545,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListGuardrailKeyAssignmentsRequest](../../models/operations/listguardrailkeyassignmentsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListGuardrailKeyAssignmentsRequest](../../models/operations/listguardrailkeyassignmentsrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.ListGuardrailKeyAssignmentsResponse](../../models/operations/listguardrailkeyassignmentsresponse.mdx)\>** +**Promise\<[operations.ListGuardrailKeyAssignmentsResponse](../../models/operations/listguardrailkeyassignmentsresponse)\>** ### Errors @@ -636,14 +636,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.BulkAssignKeysToGuardrailRequest](../../models/operations/bulkassignkeystoguardrailrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.BulkAssignKeysToGuardrailRequest](../../models/operations/bulkassignkeystoguardrailrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.BulkAssignKeysResponse](../../models/bulkassignkeysresponse.mdx)\>** +**Promise\<[models.BulkAssignKeysResponse](../../models/bulkassignkeysresponse)\>** ### Errors @@ -728,14 +728,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.BulkUnassignKeysFromGuardrailRequest](../../models/operations/bulkunassignkeysfromguardrailrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.BulkUnassignKeysFromGuardrailRequest](../../models/operations/bulkunassignkeysfromguardrailrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.BulkUnassignKeysResponse](../../models/bulkunassignkeysresponse.mdx)\>** +**Promise\<[models.BulkUnassignKeysResponse](../../models/bulkunassignkeysresponse)\>** ### Errors @@ -814,14 +814,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListGuardrailMemberAssignmentsRequest](../../models/operations/listguardrailmemberassignmentsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListGuardrailMemberAssignmentsRequest](../../models/operations/listguardrailmemberassignmentsrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.ListGuardrailMemberAssignmentsResponse](../../models/operations/listguardrailmemberassignmentsresponse.mdx)\>** +**Promise\<[operations.ListGuardrailMemberAssignmentsResponse](../../models/operations/listguardrailmemberassignmentsresponse)\>** ### Errors @@ -907,14 +907,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.BulkAssignMembersToGuardrailRequest](../../models/operations/bulkassignmemberstoguardrailrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.BulkAssignMembersToGuardrailRequest](../../models/operations/bulkassignmemberstoguardrailrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.BulkAssignMembersResponse](../../models/bulkassignmembersresponse.mdx)\>** +**Promise\<[models.BulkAssignMembersResponse](../../models/bulkassignmembersresponse)\>** ### Errors @@ -1001,14 +1001,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.BulkUnassignMembersFromGuardrailRequest](../../models/operations/bulkunassignmembersfromguardrailrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.BulkUnassignMembersFromGuardrailRequest](../../models/operations/bulkunassignmembersfromguardrailrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.BulkUnassignMembersResponse](../../models/bulkunassignmembersresponse.mdx)\>** +**Promise\<[models.BulkUnassignMembersResponse](../../models/bulkunassignmembersresponse)\>** ### Errors @@ -1083,14 +1083,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListKeyAssignmentsRequest](../../models/operations/listkeyassignmentsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListKeyAssignmentsRequest](../../models/operations/listkeyassignmentsrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.ListKeyAssignmentsResponse](../../models/operations/listkeyassignmentsresponse.mdx)\>** +**Promise\<[operations.ListKeyAssignmentsResponse](../../models/operations/listkeyassignmentsresponse)\>** ### Errors @@ -1163,14 +1163,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListMemberAssignmentsRequest](../../models/operations/listmemberassignmentsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListMemberAssignmentsRequest](../../models/operations/listmemberassignmentsrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.ListMemberAssignmentsResponse](../../models/operations/listmemberassignmentsresponse.mdx)\>** +**Promise\<[operations.ListMemberAssignmentsResponse](../../models/operations/listmemberassignmentsresponse)\>** ### Errors diff --git a/docs/sdks/images/README.mdx b/docs/sdks/images/README.mdx index 15b7b4c80..178f733a0 100644 --- a/docs/sdks/images/README.mdx +++ b/docs/sdks/images/README.mdx @@ -82,14 +82,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateImagesRequest](../../models/operations/createimagesrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.CreateImagesRequest](../../models/operations/createimagesrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.CreateImagesResponse](../../models/operations/createimagesresponse.mdx)\>** +**Promise\<[operations.CreateImagesResponse](../../models/operations/createimagesresponse)\>** ### Errors @@ -167,14 +167,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListImageModelsRequest](../../models/operations/listimagemodelsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListImageModelsRequest](../../models/operations/listimagemodelsrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.ImageModelsListResponse](../../models/imagemodelslistresponse.mdx)\>** +**Promise\<[models.ImageModelsListResponse](../../models/imagemodelslistresponse)\>** ### Errors @@ -248,14 +248,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListImageModelEndpointsRequest](../../models/operations/listimagemodelendpointsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListImageModelEndpointsRequest](../../models/operations/listimagemodelendpointsrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.ImageModelEndpointsResponse](../../models/imagemodelendpointsresponse.mdx)\>** +**Promise\<[models.ImageModelEndpointsResponse](../../models/imagemodelendpointsresponse)\>** ### Errors diff --git a/docs/sdks/models/README.mdx b/docs/sdks/models/README.mdx index ee04f92b1..a5312ca5b 100644 --- a/docs/sdks/models/README.mdx +++ b/docs/sdks/models/README.mdx @@ -79,14 +79,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetModelRequest](../../models/operations/getmodelrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.GetModelRequest](../../models/operations/getmodelrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.ModelResponse](../../models/modelresponse.mdx)\>** +**Promise\<[models.ModelResponse](../../models/modelresponse)\>** ### Errors @@ -160,14 +160,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetModelsRequest](../../models/operations/getmodelsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.GetModelsRequest](../../models/operations/getmodelsrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.GetModelsResponse](../../models/operations/getmodelsresponse.mdx)\>** +**Promise\<[operations.GetModelsResponse](../../models/operations/getmodelsresponse)\>** ### Errors @@ -237,14 +237,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListModelsCountRequest](../../models/operations/listmodelscountrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListModelsCountRequest](../../models/operations/listmodelscountrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.ModelsCountResponse](../../models/modelscountresponse.mdx)\>** +**Promise\<[models.ModelsCountResponse](../../models/modelscountresponse)\>** ### Errors @@ -320,15 +320,15 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListModelsUserRequest](../../models/operations/listmodelsuserrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `security` | [operations.ListModelsUserSecurity](../../models/operations/listmodelsusersecurity.mdx) | :heavy_check_mark: | The security requirements to use for the request. | +| `request` | [operations.ListModelsUserRequest](../../models/operations/listmodelsuserrequest) | :heavy_check_mark: | The request object to use for the request. | +| `security` | [operations.ListModelsUserSecurity](../../models/operations/listmodelsusersecurity) | :heavy_check_mark: | The security requirements to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.ListModelsUserResponse](../../models/operations/listmodelsuserresponse.mdx)\>** +**Promise\<[operations.ListModelsUserResponse](../../models/operations/listmodelsuserresponse)\>** ### Errors diff --git a/docs/sdks/oauth/README.mdx b/docs/sdks/oauth/README.mdx index b408eb9c7..9802ea0f8 100644 --- a/docs/sdks/oauth/README.mdx +++ b/docs/sdks/oauth/README.mdx @@ -83,14 +83,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ExchangeAuthCodeForAPIKeyRequest](../../models/operations/exchangeauthcodeforapikeyrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ExchangeAuthCodeForAPIKeyRequest](../../models/operations/exchangeauthcodeforapikeyrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.ExchangeAuthCodeForAPIKeyResponse](../../models/operations/exchangeauthcodeforapikeyresponse.mdx)\>** +**Promise\<[operations.ExchangeAuthCodeForAPIKeyResponse](../../models/operations/exchangeauthcodeforapikeyresponse)\>** ### Errors @@ -174,14 +174,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateAuthKeysCodeRequest](../../models/operations/createauthkeyscoderequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.CreateAuthKeysCodeRequest](../../models/operations/createauthkeyscoderequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.CreateAuthKeysCodeResponse](../../models/operations/createauthkeyscoderesponse.mdx)\>** +**Promise\<[operations.CreateAuthKeysCodeResponse](../../models/operations/createauthkeyscoderesponse)\>** ### Errors diff --git a/docs/sdks/observability/README.mdx b/docs/sdks/observability/README.mdx index bb0508987..af0162ec6 100644 --- a/docs/sdks/observability/README.mdx +++ b/docs/sdks/observability/README.mdx @@ -78,14 +78,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListObservabilityDestinationsRequest](../../models/operations/listobservabilitydestinationsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListObservabilityDestinationsRequest](../../models/operations/listobservabilitydestinationsrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.ListObservabilityDestinationsResponse](../../models/operations/listobservabilitydestinationsresponse.mdx)\>** +**Promise\<[operations.ListObservabilityDestinationsResponse](../../models/operations/listobservabilitydestinationsresponse)\>** ### Errors @@ -175,14 +175,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateObservabilityDestinationRequest](../../models/operations/createobservabilitydestinationrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.CreateObservabilityDestinationRequest](../../models/operations/createobservabilitydestinationrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.CreateObservabilityDestinationResponse](../../models/createobservabilitydestinationresponse.mdx)\>** +**Promise\<[models.CreateObservabilityDestinationResponse](../../models/createobservabilitydestinationresponse)\>** ### Errors @@ -258,14 +258,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DeleteObservabilityDestinationRequest](../../models/operations/deleteobservabilitydestinationrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.DeleteObservabilityDestinationRequest](../../models/operations/deleteobservabilitydestinationrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.DeleteObservabilityDestinationResponse](../../models/deleteobservabilitydestinationresponse.mdx)\>** +**Promise\<[models.DeleteObservabilityDestinationResponse](../../models/deleteobservabilitydestinationresponse)\>** ### Errors @@ -339,14 +339,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetObservabilityDestinationRequest](../../models/operations/getobservabilitydestinationrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.GetObservabilityDestinationRequest](../../models/operations/getobservabilitydestinationrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.GetObservabilityDestinationResponse](../../models/getobservabilitydestinationresponse.mdx)\>** +**Promise\<[models.GetObservabilityDestinationResponse](../../models/getobservabilitydestinationresponse)\>** ### Errors @@ -428,14 +428,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.UpdateObservabilityDestinationRequest](../../models/operations/updateobservabilitydestinationrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.UpdateObservabilityDestinationRequest](../../models/operations/updateobservabilitydestinationrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.UpdateObservabilityDestinationResponse](../../models/updateobservabilitydestinationresponse.mdx)\>** +**Promise\<[models.UpdateObservabilityDestinationResponse](../../models/updateobservabilitydestinationresponse)\>** ### Errors diff --git a/docs/sdks/organization/README.mdx b/docs/sdks/organization/README.mdx index 05a9d2d81..eed4ffd59 100644 --- a/docs/sdks/organization/README.mdx +++ b/docs/sdks/organization/README.mdx @@ -74,14 +74,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListOrganizationMembersRequest](../../models/operations/listorganizationmembersrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListOrganizationMembersRequest](../../models/operations/listorganizationmembersrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.ListOrganizationMembersResponse](../../models/operations/listorganizationmembersresponse.mdx)\>** +**Promise\<[operations.ListOrganizationMembersResponse](../../models/operations/listorganizationmembersresponse)\>** ### Errors diff --git a/docs/sdks/presets/README.mdx b/docs/sdks/presets/README.mdx index ca3de1fb0..9d1abf8ad 100644 --- a/docs/sdks/presets/README.mdx +++ b/docs/sdks/presets/README.mdx @@ -80,14 +80,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListPresetsRequest](../../models/operations/listpresetsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListPresetsRequest](../../models/operations/listpresetsrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.ListPresetsResponse](../../models/operations/listpresetsresponse.mdx)\>** +**Promise\<[operations.ListPresetsResponse](../../models/operations/listpresetsresponse)\>** ### Errors @@ -161,14 +161,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetPresetRequest](../../models/operations/getpresetrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.GetPresetRequest](../../models/operations/getpresetrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.GetPresetResponse](../../models/getpresetresponse.mdx)\>** +**Promise\<[models.GetPresetResponse](../../models/getpresetresponse)\>** ### Errors @@ -271,14 +271,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreatePresetsChatCompletionsRequest](../../models/operations/createpresetschatcompletionsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.CreatePresetsChatCompletionsRequest](../../models/operations/createpresetschatcompletionsrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.CreatePresetFromInferenceResponse](../../models/createpresetfrominferenceresponse.mdx)\>** +**Promise\<[models.CreatePresetFromInferenceResponse](../../models/createpresetfrominferenceresponse)\>** ### Errors @@ -377,14 +377,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreatePresetsMessagesRequest](../../models/operations/createpresetsmessagesrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.CreatePresetsMessagesRequest](../../models/operations/createpresetsmessagesrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.CreatePresetFromInferenceResponse](../../models/createpresetfrominferenceresponse.mdx)\>** +**Promise\<[models.CreatePresetFromInferenceResponse](../../models/createpresetfrominferenceresponse)\>** ### Errors @@ -471,14 +471,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreatePresetsResponsesRequest](../../models/operations/createpresetsresponsesrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.CreatePresetsResponsesRequest](../../models/operations/createpresetsresponsesrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.CreatePresetFromInferenceResponse](../../models/createpresetfrominferenceresponse.mdx)\>** +**Promise\<[models.CreatePresetFromInferenceResponse](../../models/createpresetfrominferenceresponse)\>** ### Errors @@ -559,14 +559,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListPresetVersionsRequest](../../models/operations/listpresetversionsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListPresetVersionsRequest](../../models/operations/listpresetversionsrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.ListPresetVersionsResponse](../../models/operations/listpresetversionsresponse.mdx)\>** +**Promise\<[operations.ListPresetVersionsResponse](../../models/operations/listpresetversionsresponse)\>** ### Errors @@ -643,14 +643,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetPresetVersionRequest](../../models/operations/getpresetversionrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.GetPresetVersionRequest](../../models/operations/getpresetversionrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.GetPresetVersionResponse](../../models/getpresetversionresponse.mdx)\>** +**Promise\<[models.GetPresetVersionResponse](../../models/getpresetversionresponse)\>** ### Errors diff --git a/docs/sdks/providers/README.mdx b/docs/sdks/providers/README.mdx index 55ca92d25..d54a3faf7 100644 --- a/docs/sdks/providers/README.mdx +++ b/docs/sdks/providers/README.mdx @@ -70,14 +70,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListProvidersRequest](../../models/operations/listprovidersrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListProvidersRequest](../../models/operations/listprovidersrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.ListProvidersResponse](../../models/operations/listprovidersresponse.mdx)\>** +**Promise\<[operations.ListProvidersResponse](../../models/operations/listprovidersresponse)\>** ### Errors diff --git a/docs/sdks/rerank/README.mdx b/docs/sdks/rerank/README.mdx index 2072090c6..538727614 100644 --- a/docs/sdks/rerank/README.mdx +++ b/docs/sdks/rerank/README.mdx @@ -88,14 +88,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateRerankRequest](../../models/operations/creatererankrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.CreateRerankRequest](../../models/operations/creatererankrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.CreateRerankResponse](../../models/operations/creatererankresponse.mdx)\>** +**Promise\<[operations.CreateRerankResponse](../../models/operations/creatererankresponse)\>** ### Errors diff --git a/docs/sdks/responses/README.mdx b/docs/sdks/responses/README.mdx index a6ae7a34a..e731e0def 100644 --- a/docs/sdks/responses/README.mdx +++ b/docs/sdks/responses/README.mdx @@ -128,14 +128,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateResponsesRequest](../../models/operations/createresponsesrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.CreateResponsesRequest](../../models/operations/createresponsesrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.CreateResponsesResponse](../../models/operations/createresponsesresponse.mdx)\>** +**Promise\<[operations.CreateResponsesResponse](../../models/operations/createresponsesresponse)\>** ### Errors diff --git a/docs/sdks/stt/README.mdx b/docs/sdks/stt/README.mdx index 7e0f71c4b..4e758d780 100644 --- a/docs/sdks/stt/README.mdx +++ b/docs/sdks/stt/README.mdx @@ -89,14 +89,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateAudioTranscriptionsRequest](../../models/operations/createaudiotranscriptionsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.CreateAudioTranscriptionsRequest](../../models/operations/createaudiotranscriptionsrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.STTResponse](../../models/sttresponse.mdx)\>** +**Promise\<[models.STTResponse](../../models/sttresponse)\>** ### Errors @@ -187,14 +187,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateAudioTranscriptionsMultipartRequest](../../models/operations/createaudiotranscriptionsmultipartrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.CreateAudioTranscriptionsMultipartRequest](../../models/operations/createaudiotranscriptionsmultipartrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.STTResponse](../../models/sttresponse.mdx)\>** +**Promise\<[models.STTResponse](../../models/sttresponse)\>** ### Errors diff --git a/docs/sdks/tts/README.mdx b/docs/sdks/tts/README.mdx index e769301dc..3c17931b7 100644 --- a/docs/sdks/tts/README.mdx +++ b/docs/sdks/tts/README.mdx @@ -84,14 +84,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateAudioSpeechRequest](../../models/operations/createaudiospeechrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.CreateAudioSpeechRequest](../../models/operations/createaudiospeechrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[ReadableStream\](../../models/.mdx)\>** +**Promise\<[ReadableStream\](../../models/)\>** ### Errors diff --git a/docs/sdks/videogeneration/README.mdx b/docs/sdks/videogeneration/README.mdx index 7e750e4fa..4c3e645c8 100644 --- a/docs/sdks/videogeneration/README.mdx +++ b/docs/sdks/videogeneration/README.mdx @@ -89,14 +89,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateVideosRequest](../../models/operations/createvideosrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.CreateVideosRequest](../../models/operations/createvideosrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.VideoGenerationResponse](../../models/videogenerationresponse.mdx)\>** +**Promise\<[models.VideoGenerationResponse](../../models/videogenerationresponse)\>** ### Errors @@ -173,14 +173,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetVideosRequest](../../models/operations/getvideosrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.GetVideosRequest](../../models/operations/getvideosrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.VideoGenerationResponse](../../models/videogenerationresponse.mdx)\>** +**Promise\<[models.VideoGenerationResponse](../../models/videogenerationresponse)\>** ### Errors @@ -254,14 +254,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListVideosContentRequest](../../models/operations/listvideoscontentrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListVideosContentRequest](../../models/operations/listvideoscontentrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[ReadableStream\](../../models/.mdx)\>** +**Promise\<[ReadableStream\](../../models/)\>** ### Errors @@ -333,14 +333,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListVideosModelsRequest](../../models/operations/listvideosmodelsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListVideosModelsRequest](../../models/operations/listvideosmodelsrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.VideoModelsListResponse](../../models/videomodelslistresponse.mdx)\>** +**Promise\<[models.VideoModelsListResponse](../../models/videomodelslistresponse)\>** ### Errors diff --git a/docs/sdks/workspaces/README.mdx b/docs/sdks/workspaces/README.mdx index 06ff8e8a3..07642076b 100644 --- a/docs/sdks/workspaces/README.mdx +++ b/docs/sdks/workspaces/README.mdx @@ -84,14 +84,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListWorkspacesRequest](../../models/operations/listworkspacesrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListWorkspacesRequest](../../models/operations/listworkspacesrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.ListWorkspacesResponse](../../models/operations/listworkspacesresponse.mdx)\>** +**Promise\<[operations.ListWorkspacesResponse](../../models/operations/listworkspacesresponse)\>** ### Errors @@ -178,14 +178,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateWorkspaceRequest](../../models/operations/createworkspacerequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.CreateWorkspaceRequest](../../models/operations/createworkspacerequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.CreateWorkspaceResponse](../../models/createworkspaceresponse.mdx)\>** +**Promise\<[models.CreateWorkspaceResponse](../../models/createworkspaceresponse)\>** ### Errors @@ -260,14 +260,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DeleteWorkspaceRequest](../../models/operations/deleteworkspacerequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.DeleteWorkspaceRequest](../../models/operations/deleteworkspacerequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.DeleteWorkspaceResponse](../../models/deleteworkspaceresponse.mdx)\>** +**Promise\<[models.DeleteWorkspaceResponse](../../models/deleteworkspaceresponse)\>** ### Errors @@ -343,14 +343,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetWorkspaceRequest](../../models/operations/getworkspacerequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.GetWorkspaceRequest](../../models/operations/getworkspacerequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.GetWorkspaceResponse](../../models/getworkspaceresponse.mdx)\>** +**Promise\<[models.GetWorkspaceResponse](../../models/getworkspaceresponse)\>** ### Errors @@ -432,14 +432,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.UpdateWorkspaceRequest](../../models/operations/updateworkspacerequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.UpdateWorkspaceRequest](../../models/operations/updateworkspacerequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.UpdateWorkspaceResponse](../../models/updateworkspaceresponse.mdx)\>** +**Promise\<[models.UpdateWorkspaceResponse](../../models/updateworkspaceresponse)\>** ### Errors @@ -515,14 +515,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListWorkspaceBudgetsRequest](../../models/operations/listworkspacebudgetsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListWorkspaceBudgetsRequest](../../models/operations/listworkspacebudgetsrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.ListWorkspaceBudgetsResponse](../../models/listworkspacebudgetsresponse.mdx)\>** +**Promise\<[models.ListWorkspaceBudgetsResponse](../../models/listworkspacebudgetsresponse)\>** ### Errors @@ -598,14 +598,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DeleteWorkspaceBudgetRequest](../../models/operations/deleteworkspacebudgetrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.DeleteWorkspaceBudgetRequest](../../models/operations/deleteworkspacebudgetrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.DeleteWorkspaceBudgetResponse](../../models/deleteworkspacebudgetresponse.mdx)\>** +**Promise\<[models.DeleteWorkspaceBudgetResponse](../../models/deleteworkspacebudgetresponse)\>** ### Errors @@ -687,14 +687,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.UpsertWorkspaceBudgetRequest](../../models/operations/upsertworkspacebudgetrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.UpsertWorkspaceBudgetRequest](../../models/operations/upsertworkspacebudgetrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.UpsertWorkspaceBudgetResponse](../../models/upsertworkspacebudgetresponse.mdx)\>** +**Promise\<[models.UpsertWorkspaceBudgetResponse](../../models/upsertworkspacebudgetresponse)\>** ### Errors @@ -773,14 +773,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListWorkspaceMembersRequest](../../models/operations/listworkspacemembersrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.ListWorkspaceMembersRequest](../../models/operations/listworkspacemembersrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.ListWorkspaceMembersResponse](../../models/operations/listworkspacemembersresponse.mdx)\>** +**Promise\<[operations.ListWorkspaceMembersResponse](../../models/operations/listworkspacemembersresponse)\>** ### Errors @@ -867,14 +867,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.BulkAddWorkspaceMembersRequest](../../models/operations/bulkaddworkspacemembersrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.BulkAddWorkspaceMembersRequest](../../models/operations/bulkaddworkspacemembersrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.BulkAddWorkspaceMembersResponse](../../models/bulkaddworkspacemembersresponse.mdx)\>** +**Promise\<[models.BulkAddWorkspaceMembersResponse](../../models/bulkaddworkspacemembersresponse)\>** ### Errors @@ -962,14 +962,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.BulkRemoveWorkspaceMembersRequest](../../models/operations/bulkremoveworkspacemembersrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.BulkRemoveWorkspaceMembersRequest](../../models/operations/bulkremoveworkspacemembersrequest) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[models.BulkRemoveWorkspaceMembersResponse](../../models/bulkremoveworkspacemembersresponse.mdx)\>** +**Promise\<[models.BulkRemoveWorkspaceMembersResponse](../../models/bulkremoveworkspacemembersresponse)\>** ### Errors diff --git a/scripts/fix-docs-links.sh b/scripts/fix-docs-links.sh new file mode 100755 index 000000000..f5e0546ae --- /dev/null +++ b/scripts/fix-docs-links.sh @@ -0,0 +1,53 @@ +#!/usr/bin/env bash +# Strip the `.mdx` extension from cross-references in the docs Speakeasy emits +# under docs/. +# +# Mintlify serves every page at an extensionless path, so a generated link like +# `[operations.Foo](../../models/operations/foo.mdx)` 404s while +# `[operations.Foo](../../models/operations/foo)` resolves. Speakeasy emits the +# extension, so rewrite it after every `speakeasy run`. +# +# Idempotent: no offending links -> no file changes. Pass --check to report +# offending files and exit non-zero without editing (for CI). +# +# Requires: bash, grep, sed. No network, no toolchain. +set -euo pipefail + +ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)" +cd "$ROOT" + +DOCS_DIR="docs" +# Markdown link whose target ends in `.mdx`, with an optional `#anchor`. +LINK_PATTERN='\]\([^)]*\.mdx(#[^)]*)?\)' + +if [[ ! -d "$DOCS_DIR" ]]; then + echo "missing $DOCS_DIR/" >&2 + exit 1 +fi + +did_request_check=false +if [[ "${1:-}" == "--check" ]]; then + did_request_check=true +elif [[ $# -gt 0 ]]; then + echo "usage: $0 [--check]" >&2 + exit 2 +fi + +files=() +while IFS= read -r file; do + files+=("$file") +done < <(grep -rlE "$LINK_PATTERN" "$DOCS_DIR" --include='*.mdx' | sort) + +if ((${#files[@]} == 0)); then + echo "no .mdx link extensions in $DOCS_DIR/" + exit 0 +fi + +if [[ "$did_request_check" == true ]]; then + echo "found .mdx link extensions in ${#files[@]} file(s) — run scripts/fix-docs-links.sh" >&2 + printf '%s\n' "${files[@]}" >&2 + exit 1 +fi + +sed -i -E 's/\]\(([^)]*)\.mdx(#[^)]*)?\)/](\1\2)/g' "${files[@]}" +echo "stripped .mdx link extensions in ${#files[@]} file(s)"