Main NavigationDocs Cloud ✨Donate

Appearance

Sidebar Navigation

Docs

Getting Started

Contributing

Cloud

Overview

Accounts

Queries

Teams

Self hosting

Support

Features

Overview

One-click Query Generation

Authorization

Autofill fields

Collections

Using Content Security Policy (CSP) with Altair

GraphQL Docs

Editor capabilities

Environments

File Upload

GraphQL Subscriptions

Custom request headers

Import and Export Queries

Incremental delivery (@defer and @stream)

Multiple Languages

Multiple Platforms

Window management

Pre and post request scripts

History of recent queries

Request handlers

Browser request monitoring (beta)

Schema auto refresh

Settings

Syntax and Error Highlighting

Theme Customization

Variables and Fragments

Integrations

Introduction

altair-express-middleware

altair-koa-middleware

altair-static

gatsby-plugin-altair-graphql

Learn

GraphQL

GraphQL Request Extensions

GraphQL Security

Migrating Altair Browser Extensions to Manifest v3

GraphQL Subscriptions

Web App Limitations

Plugins

Introduction

Popular plugins

Using Altair GraphQL plugins

Writing a plugin

Submitting a plugin

Plugin policy

Tips

Introduction

Deprecated Collection queries

Core API

ai

constants

Variables

maxGraphqlQueryChars

maxGraphqlQueryTokens

maxGraphqlVariablesChars

maxGraphqlVariablesTokens

maxMessageChars

maxMessageTokens

maxSdlChars

maxSdlTokens

maxTotalChars

maxTotalSessionTokens

responseMaxTokens

types

Interfaces

IMessage

IRateMessageDto

ISendMessageDto

ISession

authorization

authorization-provider

Classes

AuthorizationProvider

Interfaces

AuthorizationProviderExecuteOptions

Type Aliases

BaseAuthorizationProviderInput

Variables

baseAuthorizationProviderInputSchema

input

Type Aliases

AuthorizationProviderInput

Variables

authorizationProviderInputSchemas

providers

api-key

Classes

default

Type Aliases

ApiKeyAuthorizationProviderInput

Variables

apiKeyAuthorizationProviderInputSchema

basic

Classes

default

Type Aliases

BasicAuthorizationProviderInput

Variables

basicAuthorizationProviderInputSchema

bearer

Classes

default

Type Aliases

BearerAuthorizationProviderInput

Variables

bearerAuthorizationProviderInputSchema

oauth2

Classes

default

Type Aliases

OAuth2AuthorizationProviderInput

Variables

oAuth2AuthorizationProviderInputSchema

config

Classes

AltairConfig

Variables

isTranslateMode

Functions

getAltairConfig

setAltairConfig

defaults

Variables

DEFAULT_OPTIONS

environment

Type Aliases

ConfigEnvironment

languages

Variables

languagesSchema

options

Type Aliases

AltairConfigOptions

Functions

getOptions

options.schema

Variables

altairConfigOptionsSchema

altairWindowOptionsSchema

urls

Interfaces

UrlConfig

Variables

urlMap

crx

Variables

isExtension

isFirefoxExtension

Functions

sendMessage

evaluator

events

Variables

EVALUATOR_INIT_EXECUTE

EVALUATOR_READY

Functions

getErrorEvent

getResponseEvent

worker

Classes

EvaluatorWorker

Interfaces

EventData

identity

providers

Type Aliases

IdentityProvider

Variables

IDENTITY_PROVIDERS

Functions

getPopupUrl

index

Functions

registerPluginClass

oauth2

origins

Variables

validOrigins

plugin

base

Classes

PluginBase

Interfaces

PluginConstructor

context

context.interface

Interfaces

CreateActionOptions

CreatePanelOptions

PluginContext

PluginContextGenerator

PluginWindowState

event

event.interfaces

Interfaces

PluginEventPayloadMap

Type Aliases

PluginEvent

PluginEventCallback

panel

Enumerations

AltairPanelLocation

Classes

AltairPanel

plugin.interfaces

Interfaces

RemotePluginListItem

RemotePluginListResponse

Type Aliases

AltairV1Plugin

PluginManifest

PluginSource

PluginType

Functions

createV1Plugin

plugin.schema

Variables

altairV1PluginSchema

pluginCapabilitiesSchema

pluginManifestSchema

pluginSourceSchema

pluginTypeSchema

server

schema

Type Aliases

APSApprovedPluginsYamlManifest

APSPluginDefinition

APSPluginListResponse

Variables

altairPluginServerApprovedPluginsYamlManifestSchema

altairPluginServerPluginDefinitionSchema

altairPluginServerPluginListResponseSchema

ui-action

Enumerations

AltairUiActionLocation

Classes

AltairUiAction

v3

capabilities

context

Interfaces

PluginUserInfo

PluginV3Context

events

Variables

PLUGIN_CREATE_ACTION_EVENT

PLUGIN_ENGINE_READY

PLUGIN_GET_APP_STYLE_URL_EVENT

PLUGIN_SANDBOX_BOOTSTRAP_READY

PLUGIN_SANDBOX_INITIALIZE

PLUGIN_SANDBOX_INITIALIZED

PLUGIN_SUBSCRIBE_TO_EVENT

Functions

getActionEvent

frame-engine

Classes

PluginFrameEngine

frame-worker

Classes

PluginFrameWorker

Interfaces

FrameOptions

Type Aliases

InstanceType

Variables

instanceTypes

manifest

Type Aliases

PluginEntry

PluginIcon

PluginV3Manifest

Variables

pluginEntrySchema

pluginIconSchema

pluginV3ManifestSchema

panel

Classes

AltairV3Panel

parent-engine

Classes

PluginParentEngine

parent-worker

Classes

PluginParentWorker

Interfaces

PluginSandboxInitialization

Type Aliases

PluginParentWorkerOptions

plugin

Classes

PluginV3

Interfaces

PluginV3Options

source

request

adapters

Classes

SubscriptionProviderRequestHandlerAdapter

handlers

action-cable

Classes

ActionCableRequestHandler

app-sync

Classes

AppSyncRequestHandler

graphql-ws

Classes

GraphQLWsRequestHandler

http

Classes

HttpRequestHandler

sse

Classes

SSERequestHandler

ws

Classes

WebsocketRequestHandler

ids

Variables

ACTION_CABLE_HANDLER_ID

APP_SYNC_HANDLER_ID

GRAPHQL_SSE_HANDLER_ID

GRAPHQL_WS_HANDLER_ID

HTTP_HANDLER_ID

WEBSOCKET_HANDLER_ID

response-builder

Functions

buildResponse

schemas

Enumerations

MultiResponseStrategy

Variables

multiResponseStrategySchema

requestHandlerIdsSchema

types

Enumerations

MultiResponseStrategy

Interfaces

GraphQLRequestHandler

GraphQLRequestOptions

GraphQLResponseData

RequestHandlerData

Type Aliases

RequestHandlerIds

utils

Functions

simpleResponseObserver

script

context

Variables

ModuleImports

Functions

buildContextResponse

getGlobalContext

importModuleHelper

errors

Classes

RequestScriptError

evaluator-client-engine

Classes

ScriptEvaluatorClientEngine

evaluator-worker-engine

Classes

ScriptEvaluatorWorkerEngine

Type Aliases

WorkerHandlerNames

events

Variables

SCRIPT_INIT_EXECUTE

Functions

getErrorEvent

getResponseEvent

types

Enumerations

RequestType

Classes

ScriptEvaluatorClient

ScriptEvaluatorWorker

Interfaces

AllScriptEventHandlers

CookieOptions

FullTransformResult

GlobalContextBuilderHandlers

GlobalHelperContext

ModuleImportsMap

ScriptContextData

ScriptContextHelpers

ScriptContextResponse

ScriptContextStorage

ScriptEvaluatorClientFactory

ScriptEventDataPayload

ScriptEventErrorPayload

ScriptEventHandlers

ScriptEventResponsePayload

ScriptTransformResult

ScriptWorkerMessageData

SendRequestResponse

Type Aliases

SameSite

ScriptEvent

ScriptEventData

ScriptEventParameters

ScriptResponseEvent

subscriptions

Interfaces

SubscriptionProviderData

subscription-provider

Classes

SubscriptionProvider

Interfaces

SubscriptionProviderExecuteOptions

SubscriptionProviderExtraOptions

Type Aliases

SubscriptionProviderConstructor

test-helpers

Classes

MswMockRequestHandler

theme

Variables

dark

dracula

light

css

Functions

getCSS

defaults

dark

Variables

default

dracula

Variables

default

light

Variables

default

theme

Type Aliases

ICustomTheme

ITheme

Variables

foundationColors

oldThemeSchema

themeConfigSchema

themeSchema

Functions

createTheme

hexToRgbStr

mergeThemes

transformOldThemeConfigToNewThemeConfig

typegen

partial-settings

Type Aliases

Type

settings

Type Aliases

Type

types

messaging

Type Aliases

WebExtensionMessage

shared

Interfaces

BaseDocument

BaseOwnableDocument

Type Aliases

CreateDTO

IDictionary

NoExtraProperties

RecursivePartial

TODO

UpdateDTO

state

account.interfaces

Classes

TeamId

Interfaces

AccountState

IAvailableCredits

IPlan

IPlanInfo

Team

authorization.interface

Interfaces

AuthorizationResult

AuthorizationState

Type Aliases

AuthorizationTypes

Variables

AUTHORIZATION_TYPES

AUTHORIZATION_TYPE_LIST

DEFAULT_AUTHORIZATION_TYPE

collection.interfaces

Interfaces

CollectionState

ExportCollectionState

IQuery

IQueryCollection

IQueryCollectionTree

IRemoteQuery

IRemoteQueryCollection

Type Aliases

EntityStorageType

SortByOptions

collections-meta.interfaces

Interfaces

CollectionsMetaState

dialog.interfaces

Interfaces

DialogState

docs.interfaces

Interfaces

DirectiveDocView

DocsState

FieldDocView

RootDocView

SearchDocView

TypeDocView

Type Aliases

DocView

donation.interfaces

Interfaces

DonationState

environments.interfaces

Interfaces

BaseEnvironmentState

EnvironmentState

EnvironmentVariableData

EnvironmentsState

ExportEnvironmentState

IEnvironment

Type Aliases

EnvironmentVariableSourceType

EnvironmentVariables

IInitialEnvironments

InitialEnvironmentState

Variables

ENVIRONMENT_VARIABLE_SOURCE_TYPE

environments.schema

Variables

initialEnvironmentSchema

initialEnvironmentsSchema

gql-schema.interfaces

Interfaces

GQLSchemaState

header.interfaces

Interfaces

Header

Type Aliases

HeaderState

history.interfaces

Interfaces

History

HistoryState

layout.interfaces

Interfaces

LayoutState

local.interfaces

Interfaces

LoadingRequestStateEntry

LocalState

TemporaryWindowStateEntry

V1PluginStateEntry

V3PluginStateEntry

per-window.interfaces

Interfaces

PerWindowState

postrequest.interfaces

Interfaces

PostrequestState

prerequest.interfaces

Interfaces

PrerequestState

query.interfaces

Interfaces

LogLine

QueryEditorState

QueryResponse

QueryState

RequestHandlerInfo

Type Aliases

HttpVerb

SelectedOperation

query.schema

Variables

httpVerbSchema

settings.interfaces

Type Aliases

SettingsState

settings.schema

Variables

partialSettingsSchema

settingsSchema

state.interfaces

Interfaces

RootState

stream.interfaces

Interfaces

StreamState

variable.interfaces

Interfaces

FileVariable

VariableState

window.interfaces

Interfaces

ExportWindowState

WindowState

windows-meta.interfaces

Interfaces

WindowsMetaState

workspace.interface

Classes

WorkspaceId

Interfaces

Workspace

WorkspacesState

Variables

WORKSPACES

utils

dot-notation

Functions

setByDotNotation

graphql

Functions

getOperations

headers

Functions

headerListToMap

headerMapToList

inject

Functions

injectScript

injectStylesheet

is_electron

Variables

default

json

Functions

parseJson

logger

Interfaces

ILogger

Functions

createLogger

schema

Functions

stripDefaults

url

Functions

urlWithParams

value-object

Classes

ValueObject

On this page

Table of Contents for current page

accessTokenResponseSchema

const accessTokenResponseSchema: ZodObject<AccessTokenResponse>

Help us improve this page!

Next pageGetting Started