/

Docs
History
Schema
Generate

Filter operations

Gateway292

get/modelsList gateway models
get/models/{author}/{slug}/endpointsList model endpoint capabilities
get/models/meList team-scoped gateway models
get/providersList providers
get/generationsGet generation
post/chat/completionsCreate chat completion
post/responsesCreate response
get/async/{kind}/{id}/wsOpen async job websocket
post/messagesCreate message
post/embeddingsCreate embeddings
post/moderationsCreate moderation
post/rerankRerank documents
post/decisionsMake structured decisions
post/extractionsExtract typed values
post/audio/speechGenerate speech
post/audio/transcriptionsCreate transcription
post/audio/translationsCreate translation
post/audio/realtime/sessionsCreate realtime audio session
post/live/sessionsCreate GPT Live session
get/audio/realtime/sessions/{session_id}/relayConnect realtime relay
post/audio/realtime/sessions/{session_id}/connectedMark realtime session connected
post/audio/realtime/sessions/{session_id}/extendExtend realtime session credit hold
post/audio/realtime/sessions/{session_id}/usageUpdate realtime session usage
post/audio/realtime/sessions/{session_id}/finalizeFinalize realtime audio session
post/images/generationsCreate image
post/images/editsCreate image edit
get/videosList videos
post/videosCreate video
get/videos/modelsList video model capabilities
get/videos/{video_id}Get video status
delete/videos/{video_id}Delete video
post/videos/{video_id}/cancelCancel video
get/videos/{video_id}/contentGet video content
post/videos/{video_id}/download_urlCreate a signed video download URL
post/ocrCreate OCR
post/parseParse a document image
post/music/generateGenerate music
get/music/generate/{music_id}Get music generation status
get/filesList files
post/filesUpload file
get/files/{file_id}Retrieve file
get/files/{file_id}/contentRetrieve file content
get/batchesList batches
post/batchesCreate batch
get/batches/modelsList batch model capabilities
get/batches/capabilitiesList batch provider capabilities
get/batches/filesList batch files
post/batches/filesUpload batch file
get/batches/files/{file_id}Retrieve batch file
get/batches/files/{file_id}/contentRetrieve batch file content
get/batches/{batch_id}Retrieve batch
get/batches/{batch_id}/resultsDownload batch results
get/batches/{batch_id}/requestsList batch request rows
post/batches/{batch_id}/cancelCancel batch
get/analyticsGet workspace analytics
get/analytics/exportExport workspace analytics
get/creditsGet remaining credits
post/credits/topupsStart a credit top-up
get/credits/topups/{id}Get a credit top-up
get/keyGet current API key
get/keysList API keys
post/keysCreate a new API key
get/keys/{id}Get a single API key
delete/keys/{id}Delete an API key
patch/keys/{id}Update an API key
post/keys/{id}/rotateRotate an API key
post/keys/{id}/invalidateInvalidate API key cache
get/identity/ssoGet workspace SSO settings
put/identity/ssoUpdate workspace SSO settings
get/identity/scimGet workspace SCIM settings
put/identity/scimEnable or disable SCIM
post/identity/scim/tokensCreate a SCIM token
delete/identity/scim/tokens/{id}Revoke a SCIM token
get/identity/scim/auditList SCIM audit events
get/identity/directoryGet the workspace directory
put/identity/directory/members/{id}Update a directory member override
get/identity/departmentsList workspace departments
post/identity/departmentsCreate a workspace department
delete/identity/departments/{id}Delete a workspace department
patch/identity/departments/{id}Update a workspace department
put/identity/departments/{departmentId}/members/{userId}Set a manual department membership
delete/identity/departments/{departmentId}/members/{userId}Delete a manual department membership
get/identity/group-mappingsList directory group mappings
post/identity/group-mappingsCreate a directory group mapping
delete/identity/group-mappings/{id}Delete a directory group mapping
patch/identity/group-mappings/{id}Update a directory group mapping
get/notifications/settingsGet workspace notification settings
patch/notifications/settingsUpdate workspace notification settings
get/appsList workspace applications
patch/apps/{id}Update a workspace application
post/apps/{id}/mergeMerge workspace applications
get/logsList gateway request logs
get/logs/{requestId}Get a gateway request log
get/feedbackList gateway feedback
post/feedbackCreate gateway feedback
get/feedback/summarySummarize gateway feedback
get/eventsList gateway observability events
post/eventsCreate a gateway observability event
get/preset-test-runsList preset test runs
post/preset-test-runsCreate a preset test run
get/preset-test-runs/{id}Get a preset test run
patch/preset-test-runs/{id}Update a preset test run
get/byokList provider credentials
post/byokCreate a provider credential
post/byok/reorderReorder provider credentials
get/byok/{id}Get a provider credential
delete/byok/{id}Delete a provider credential
patch/byok/{id}Update a provider credential
get/private-modelsList private models
post/private-modelsCreate a private model
get/private-models/{id}Get a private model
delete/private-models/{id}Delete a private model
patch/private-models/{id}Update a private model
get/budgetsList workspace budgets
post/budgetsCreate a workspace budget
get/budgets/{id}Get a workspace budget
delete/budgets/{id}Delete a workspace budget
patch/budgets/{id}Update a workspace budget
get/department-budgetsList department budgets
post/department-budgetsCreate a department budget
get/department-budgets/{id}Get a department budget
delete/department-budgets/{id}Delete a department budget
patch/department-budgets/{id}Update a department budget
get/workload-identity/policiesList trusted workload policies
post/workload-identity/policiesCreate a trusted workload policy
get/workload-identity/policies/{id}Get a trusted workload policy
delete/workload-identity/policies/{id}Delete a trusted workload policy
patch/workload-identity/policies/{id}Update a trusted workload policy
get/rate-limits/policiesList rate limit policies
post/rate-limits/policiesCreate a rate limit policy
get/rate-limits/policies/{id}Get a rate limit policy
delete/rate-limits/policies/{id}Delete a rate limit policy
patch/rate-limits/policies/{id}Update a rate limit policy
get/rate-limits/assignmentsList rate limit assignments
post/rate-limits/assignmentsAssign a rate limit policy
get/rate-limits/assignments/{id}Get a rate limit assignment
delete/rate-limits/assignments/{id}Delete a rate limit assignment
patch/rate-limits/assignments/{id}Change an assignment's policy
get/spend-rulesList spend rules
post/spend-rulesCreate a spend rule
get/spend-rules/{id}Get a spend rule
delete/spend-rules/{id}Delete a spend rule
patch/spend-rules/{id}Update a spend rule
post/spend-rules/{id}/testSend a test spend alert
get/spend-rules/{id}/previewPreview a spend rule
get/spend-rules/{id}/historyList spend rule history
get/spend-blocksList spend blocks
post/spend-blocks/{id}/liftLift a spend block
get/classifiersList classifiers
post/classifiersCreate a classifier
post/classifiers/testTest a classifier on a sample
get/classifiers/{id}Get a classifier
delete/classifiers/{id}Delete a classifier
patch/classifiers/{id}Update a classifier
get/notifications/destinationsList notification destinations
post/notifications/destinationsCreate a notification destination
delete/notifications/destinations/{id}Delete a notification destination
post/notifications/destinations/testTest notification destination configuration
post/notifications/destinations/{id}/testTest a saved notification destination
post/notifications/destinations/{id}/rotate-secretRotate a notification webhook signing secret
get/notifications/routesList notification routes
put/notifications/routes/{eventKind}Update a notification route
get/data-contributionGet data contribution settings
patch/data-contribution/consentUpdate data contribution consent
post/data-contribution/classifiersCreate a data contribution classifier
delete/data-contribution/classifiers/{id}Delete a data contribution classifier
patch/data-contribution/classifiers/{id}Update a data contribution classifier
get/oauth-clientsList OAuth clients
post/oauth-clientsCreate an OAuth client
get/oauth-clients/{client_id}Get an OAuth client
delete/oauth-clients/{client_id}Delete an OAuth client
patch/oauth-clients/{client_id}Update an OAuth client
post/oauth-clients/{client_id}/regenerate-secretRegenerate an OAuth client secret
get/webhook-endpointsList webhook endpoints
post/webhook-endpointsCreate a webhook endpoint
get/webhook-endpoints/{id}Get a webhook endpoint
delete/webhook-endpoints/{id}Delete a webhook endpoint
patch/webhook-endpoints/{id}Update a webhook endpoint
post/webhook-endpoints/{id}/rotate-secretRotate a webhook signing secret
post/webhook-endpoints/{id}/testSend a test webhook event
get/guardrailsList guardrails
post/guardrailsCreate a guardrail
get/guardrails/{id}Get a guardrail
delete/guardrails/{id}Delete a guardrail
patch/guardrails/{id}Update a guardrail
get/guardrails/{id}/keysList guardrail key assignments
put/guardrails/{id}/keysReplace guardrail key assignments
post/guardrails/{id}/keys/addAdd guardrail key assignments
post/guardrails/{id}/keys/removeRemove guardrail key assignments
get/guardrails/{id}/membersList guardrail member assignments
post/guardrails/{id}/members/addAdd guardrail member assignments
post/guardrails/{id}/members/removeRemove guardrail member assignments
get/management-keysList management keys
post/management-keysCreate a management key
get/management-keys/{id}Get a management key
delete/management-keys/{id}Delete a management key
patch/management-keys/{id}Update a management key
get/activityGet recent activity
get/audit-eventsList workspace audit events
get/workspacesList workspaces
post/workspacesCreate a workspace
get/workspaces/{id}Get a workspace
delete/workspaces/{id}Delete a workspace
patch/workspaces/{id}Update a workspace
get/workspaces/{id}/membersList workspace members
post/workspaces/{id}/members/addAdd workspace members
post/workspaces/{id}/members/removeRemove workspace members
patch/workspaces/{id}/members/{user_id}Update a workspace member role
get/workspaces/{id}/invitesList workspace invites
post/workspaces/{id}/invitesCreate a workspace invite
delete/workspaces/{id}/invites/{invite_id}Delete a workspace invite
get/workspaces/{id}/join-requestsList workspace join requests
post/workspaces/{id}/join-requests/{request_id}/approveApprove a workspace join request
post/workspaces/{id}/join-requests/{request_id}/rejectReject a workspace join request
get/observability/logging-policyGet workspace I/O logging policy
patch/observability/logging-policyUpdate workspace I/O logging policy
get/observability/destinationsList observability destinations
post/observability/destinationsCreate an observability destination
get/observability/destinations/{id}Get an observability destination
delete/observability/destinations/{id}Delete an observability destination
patch/observability/destinations/{id}Update an observability destination
get/organisationsList organisations
get/pricing/modelsList pricing models
post/pricing/calculateCalculate pricing
get/health/providers/{provider_id}/derankProvider derank status
get/healthHealth check
get/video/generationsList videos (alias)
post/video/generationsCreate video (alias)
get/video/generations/modelsList video model capabilities (alias)
get/video/generations/{video_id}Get video status (alias)
delete/video/generations/{video_id}Delete video (alias)
post/video/generations/{video_id}/cancelCancel video (alias)
get/video/generations/{video_id}/contentGet video content (alias)
post/video/generations/{video_id}/download_urlCreate a signed video download URL (alias)
post/music/generationsGenerate music (alias)
get/music/generations/{music_id}Get music generation status (alias)
get/batchList batches (alias)
post/batchCreate batch (alias)
get/batch/modelsList batch model capabilities (alias)
get/batch/capabilitiesList batch provider capabilities (alias)
get/batch/filesList batch files (alias)
post/batch/filesUpload batch file (alias)
get/batch/files/{file_id}Retrieve batch file (alias)
get/batch/files/{file_id}/contentRetrieve batch file content (alias)
get/batch/{id}Retrieve batch (alias)
get/batch/{id}/resultsDownload batch results (alias)
get/batch/{id}/requestsList batch request rows (alias)
post/batch/{id}/cancelCancel batch (alias)
get/data/modelsList data models
get/presetsList presets
post/presetsCreate a preset
get/presets/publisherGet preset publisher handle
put/presets/publisherUpdate preset publisher handle
get/presets/{id}Get a preset
delete/presets/{id}Archive a preset
patch/presets/{id}Update a preset draft
get/presets/{id}/versionsList preset versions
post/presets/{id}/versionsPublish a preset version
get/presets/{id}/labelsList preset labels
put/presets/{id}/labels/{label}Set a preset label
delete/presets/{id}/labels/{label}Remove a preset label
post/presets/{id}/forkFork a public preset
post/presets/{id}/upstreamApply an upstream preset version
get/settingsGet workspace settings
patch/settingsUpdate workspace settings
get/routing/dynamic-routesList dynamic routes
post/routing/dynamic-routesCreate a dynamic route
get/routing/dynamic-routes/{id}Get a dynamic route
delete/routing/dynamic-routes/{id}Delete a dynamic route
patch/routing/dynamic-routes/{id}Update a dynamic route
put/routing/dynamic-routes/{id}/keysReplace dynamic-route API keys
post/routing/dynamic-routes/{id}/versions/{version}/deployDeploy a dynamic-route version
get/endpointsList endpoints
get/meGet the signed-in user
get/me/profileGet your profile
patch/me/profileUpdate your profile
get/me/authorized-appsList apps you have authorized
delete/me/authorized-apps/{id}Revoke an authorized app
patch/me/authorized-apps/{id}Remove scopes from an authorized app
post/invites/acceptAccept a workspace invite
get/invites/requestsList your requests to join workspaces
get/rate-limits/tierGet the workspace's rate limit tier
post/rate-limits/tier/raiseRaise the workspace's rate limit tier
get/routing/autoGet auto-routing settings
patch/routing/autoUpdate auto-routing settings
get/routing/successor/replacementsList successor model replacements
put/routing/successor/replacementsSave a successor model replacement
delete/routing/successor/replacementsRemove a successor model replacement
post/observability/destinations/testTest destination settings before saving
post/observability/destinations/{id}/testCheck a destination's connection
post/observability/destinations/{id}/sampleSend a sample trace
post/security/report-leaked-keyReport a leaked API key

Gateway

Changes to Get a spend rule

get/spend-rules/{id}

Oct 27, 202658847d40a023 Revision changes
- info
  endpoint added