sdk

7.0.12

Explore all defined data models and types for this version. For live editing and client SDK generators, inspect on TypeHub.

Open in TypeHub
Defined Types (287)
Agent_Input
This object represents an agent input
Type
Agent_Item
Agent item
Type
Agent_ItemBinary
Binary agent message
Type
Agent_ItemChoice
Choice agent message
Type
Agent_ItemObject
Structured agent message
Type
Agent_ItemText
Text agent message
Type
Agent_ItemToolCall
Tool call agent message
Type
Agent_ItemToolCallFunction
Concrete values for a function tool call
Type
Agent_Output
This object represents an agent output
Type
Backend_AccountChangePassword
Payload required to update the current user's password
Type
Backend_Action
This object represents the business logic which can be executed either through an operation or cronjob
Type
Backend_ActionCollection
A paginated collection of action objects
Type
Backend_ActionCommit
An action commit which represents a change in the action configuration
Type
Backend_ActionCommitCollection
A paginated collection of action commit objects
Type
Backend_ActionConfig
The action configuration which contains arbitrary key-value entries
Type
Backend_ActionCreate
Payload for creating a new action entity
Type
Backend_ActionExecuteRequest
Represents a request to execute an action
Type
Backend_ActionExecuteRequestBody
Represents a request body
Type
Backend_ActionExecuteResponse
Represents an action execution response
Type
Backend_ActionExecuteResponseBody
Represents a response body
Type
Backend_ActionExecuteResponseHeaders
Represents a map of headers
Type
Backend_ActionIndex
Contains all possible classes which can be used at an action as class
Type
Backend_ActionIndexEntry
Represents a concrete action class
Type
Backend_ActionUpdate
Payload for updating an existing action entity
Type
Backend_Agent
This object represents an agent
Type
Backend_AgentCollection
Represents a collection of agent messages
Type
Backend_AgentCreate
Payload for creating a new AI agent
Type
Backend_AgentMessage
This object represents an agent message
Type
Backend_AgentMessageCollection
Represents a collection of agent messages
Type
Backend_AgentTool
Represents a concrete tool
Type
Backend_AgentTools
Represents a collection of available tools
Type
Backend_AgentUpdate
Payload for updating an existing AI agent
Type
Backend_App
This object represents an app to access the API on-behalf of a user
Type
Backend_AppCollection
A paginated collection of app objects
Type
Backend_AppCreate
Payload for creating a new consumer application
Type
Backend_AppUpdate
Payload for updating an existing consumer application
Type
Backend_Audit
This object represents an audit which is created every time something was changed at the system
Type
Backend_AuditCollection
A paginated collection of audit objects
Type
Backend_AuditObject
A key value object containing the changes
Type
Backend_BackupExport
Export of the complete system configuration
Type
Backend_BackupImport
Import a previously exported system configuration
Type
Backend_BackupImportResult
Result of a backup import operation
Type
Backend_Bundle
This object represents a bundle which contains action, schema, event, cronjob and trigger configurations from you local instance
Type
Backend_BundleCollection
A paginated collection of bundle objects
Type
Backend_BundleConfig
Configuration settings and resource specs exported within the bundle
Type
Backend_BundleCreate
Payload for creating a new configuration bundle
Type
Backend_BundleUpdate
Payload for updating an existing configuration bundle
Type
Backend_Category
This object represents a category. Every user is assigned to a category and can only view objects which are also assigned to the same category, through this it is possible to build separate areas for external developers
Type
Backend_CategoryCollection
A paginated collection of category objects
Type
Backend_CategoryCreate
Payload for creating a new category
Type
Backend_CategoryUpdate
Payload for updating an existing category
Type
Backend_Config
This object represents a system configuration
Type
Backend_ConfigCollection
A paginated collection of config objects
Type
Backend_ConfigUpdate
Payload for updating a system configuration entry
Type
Backend_Connection
This object represents a connection to an external system like i.e. a database, message-queue or client-sdk
Type
Backend_ConnectionCollection
A paginated collection of connection objects
Type
Backend_ConnectionConfig
The connection configuration which contains arbitrary key-value entries
Type
Backend_ConnectionCreate
Payload for creating a new connection
Type
Backend_ConnectionIndex
Contains all possible classes which can be used at an connection as class
Type
Backend_ConnectionIndexEntry
Represents a concrete connection class
Type
Backend_ConnectionRedirectResponse
Redirect response to initiate an OAuth2 flow
Type
Backend_ConnectionUpdate
Payload for updating an existing connection
Type
Backend_Cronjob
This object represents a cronjob which can invoke an action at a specific interval
Type
Backend_CronjobCollection
A paginated collection of cronjob objects
Type
Backend_CronjobCreate
Payload for creating a new cronjob
Type
Backend_CronjobError
Represents an error which occurred on cronjob execution
Type
Backend_CronjobUpdate
Payload for updating an existing cronjob
Type
Backend_Dashboard
Represents an object containing all widget data for the dashboard
Type
Backend_DatabaseRow
This object represents a row on a relational table
Type
Backend_DatabaseRowCollection
A paginated collection of database rows
Type
Backend_DatabaseTable
This object represents a relational table on a database connection
Type
Backend_DatabaseTableCollection
A paginated collection of database table objects
Type
Backend_DatabaseTableColumn
This object represents a column at a relation table
Type
Backend_DatabaseTableForeignKeyConstraint
This object represents a foreign key constraint on a relational database
Type
Backend_DatabaseTableIndex
This object represents a table index on a relational database
Type
Backend_Event
This object represents an event which can be triggered by an action
Type
Backend_EventCollection
A paginated collection of event objects
Type
Backend_EventCreate
Payload for creating a new event entity
Type
Backend_EventUpdate
Payload for updating an existing event entity
Type
Backend_File
This object represents a file on the filesystem
Type
Backend_FileCollection
A paginated collection of file objects
Type
Backend_Firewall
This object represents a firewall rule which blocks specific IP addresses
Type
Backend_FirewallCollection
A paginated collection of firewall objects
Type
Backend_FirewallCreate
Payload for creating a new firewall rule
Type
Backend_FirewallUpdate
Payload for updating an existing firewall rule
Type
Backend_Form
This object represents a form which helps to dynamically generate a form at a frontend app
Type
Backend_FormCollection
A paginated collection of form objects
Type
Backend_FormCreate
Payload for creating a new form definition
Type
Backend_FormUpdate
Payload for updating an existing form definition
Type
Backend_GeneratorIndexProvider
Represents a concrete generator class
Type
Backend_GeneratorIndexProviders
Contains all possible classes which can be used at an generator as class
Type
Backend_GeneratorProvider
Configuration object used to invoke a schema/operation generator
Type
Backend_GeneratorProviderChangelog
Represents a preview changelog of entities created or updated by a generator run
Type
Backend_GeneratorProviderConfig
Arbitrary configuration map for the generator provider
Type
Backend_HttpRequest
This object represents a HTTP request
Type
Backend_HttpResponse
This object represents a HTTP response
Type
Backend_Identity
This object represents an identity which allows to authenticate with a remote identity provider
Type
Backend_IdentityCollection
A paginated collection of identity objects
Type
Backend_IdentityConfig
Identity provider configuration containing key-value parameters
Type
Backend_IdentityCreate
Payload for creating a new identity provider entity
Type
Backend_IdentityIndex
Contains all possible classes which can be used at an identity as class
Type
Backend_IdentityIndexEntry
Represents a concrete identity class
Type
Backend_IdentityUpdate
Payload for updating an existing identity provider entity
Type
Backend_Log
This object represents a log entry. Every HTTP requests to the system generates such a log entry.
Type
Backend_LogCollection
A paginated collection of log objects
Type
Backend_LogError
Represents an error logged during a specific HTTP request
Type
Backend_LogErrorCollection
A paginated collection of log error objects
Type
Backend_Operation
This object represents an operation, an operation invokes an action in case a specific HTTP method and path was requested. It defines also schema information about the request and response payload
Type
Backend_OperationCollection
A paginated collection of operation objects
Type
Backend_OperationCreate
Payload for creating a new operation entity
Type
Backend_OperationParameters
Map of path or query parameters accepted by the operation
Type
Backend_OperationSchema
Defines primitive type constraints for parameter schema definitions
Type
Backend_OperationThrows
Map of HTTP error status codes to target schema names
Type
Backend_OperationUpdate
Payload for updating an existing operation entity
Type
Backend_Page
This object represents a page at the developer portal
Type
Backend_PageCollection
A paginated collection of page objects
Type
Backend_PageCreate
Payload for creating a new portal page
Type
Backend_PageUpdate
Payload for updating an existing portal page
Type
Backend_Plan
This object represents a plan, a plan allows users to obtain points or in general subscribe to your app
Type
Backend_PlanCollection
A paginated collection of plan objects
Type
Backend_PlanCreate
Payload for creating a new subscription or point plan
Type
Backend_PlanUpdate
Payload for updating an existing plan definition
Type
Backend_Rate
This object represents a rate limitation, which allows to limit the requests which a user can send
Type
Backend_RateAllocation
This object represents a rate allocation, in case a request matches it gets assigned to the attached rate
Type
Backend_RateCollection
A paginated collection of rate objects
Type
Backend_RateCreate
Payload for creating a new rate limit policy
Type
Backend_RateUpdate
Payload for updating an existing rate limit policy
Type
Backend_Role
This object represents a role, every user is assigned to a role and all scopes of the role are automatically attached to the user
Type
Backend_RoleCollection
A paginated collection of role objects
Type
Backend_RoleCreate
Payload for creating a new user role entity
Type
Backend_RoleUpdate
Payload for updating an existing user role entity
Type
Backend_Schema
This object represents a schema to describe a JSON payload
Type
Backend_SchemaCollection
A paginated collection of schema objects
Type
Backend_SchemaCommit
A schema commit which represents a change in the schema source
Type
Backend_SchemaCommitCollection
A paginated collection of schema commit objects
Type
Backend_SchemaCreate
Payload for creating a new schema definition
Type
Backend_SchemaPreviewResponse
Response container for a generated schema code preview
Type
Backend_SchemaSource
Contains the TypeSchema specification
Type
Backend_SchemaUpdate
Payload for updating an existing schema definition
Type
Backend_Scope
This object represents a scope. A scope is assigned to a user and is required to access operations
Type
Backend_ScopeCategories
Container for grouping available scopes into logical categories
Type
Backend_ScopeCategory
Represents a functional grouping of scopes
Type
Backend_ScopeCategoryScope
Simplified scope representation within a category view
Type
Backend_ScopeCollection
A paginated collection of scope objects
Type
Backend_ScopeCreate
Payload for creating a new scope entity
Type
Backend_ScopeOperation
Mapping defining access permissions for a specific operation within a scope
Type
Backend_ScopeUpdate
Payload for updating an existing scope entity
Type
Backend_SdkGenerate
Payload defining target format and configuration for triggering an SDK generation run
Type
Backend_SdkMessage
Response structure detailing the outcome of an SDK generation job
Type
Backend_SdkResponse
Container listing target SDK languages or formats available for generator execution
Type
Backend_SdkTypes
Represents available SDK type which can be generated
Type
Backend_SpecificationChangelog
Represents structural changelog differences between specification versions
Type
Backend_SpecificationGet
Container delivering the compiled API specification schema object
Type
Backend_SpecificationPublish
Payload defining configuration parameters for publishing an API specification export
Type
Backend_StatisticChart
Represents dataset structures formatted for rendering statistic charts
Type
Backend_StatisticChartSeries
A single data line or bar series for a statistic chart
Type
Backend_StatisticCount
Represents an aggregated count metric over a specific timeframe
Type
Backend_Taxonomy
This object represents a taxonomy. A taxonomy helps to internally organize operations, actions and other entities
Type
Backend_TaxonomyCollection
A paginated collection of taxonomy objects
Type
Backend_TaxonomyCreate
Payload for creating a new taxonomy organization node
Type
Backend_TaxonomyMove
Moves the provided objects to a taxonomy
Type
Backend_TaxonomyUpdate
Payload for updating an existing taxonomy node
Type
Backend_Test
This object represents a test. A test helps to verify that all operations work as expected
Type
Backend_TestCollection
A paginated collection of test objects
Type
Backend_TestConfig
Configuration parameters for executing a test run
Type
Backend_Token
This object represents a token, this an access token which was requested by a user
Type
Backend_TokenCollection
A paginated collection of token objects
Type
Backend_Transaction
This object represents a transaction. The system generates a transaction in case a payment was successfully executed
Type
Backend_TransactionCollection
A paginated collection of transaction objects
Type
Backend_TrashData
This object represents a deleted item stored in the trash bin
Type
Backend_TrashDataCollection
A paginated collection of deleted objects
Type
Backend_TrashRestore
Request payload to restore an item from the trash bin
Type
Backend_TrashTypes
List of available entity types that can be restored from the trash
Type
Backend_Trigger
This object represents a trigger which can invoke an action on a custom event
Type
Backend_TriggerCollection
A paginated collection of trigger objects
Type
Backend_TriggerCreate
Request payload to create a new trigger
Type
Backend_TriggerUpdate
Request payload to update an existing trigger
Type
Backend_User
This object represents a user
Type
Backend_UserCollection
A paginated collection of user objects
Type
Backend_UserCreate
Request payload to register or create a new user account
Type
Backend_UserUpdate
Request payload to update existing user account information
Type
Backend_Webhook
This object represents a webhook, a webhook is called in case a specific event was triggered
Type
Backend_WebhookCollection
A paginated collection of webhook objects
Type
Backend_WebhookCreate
Request payload to create a new webhook subscription
Type
Backend_WebhookResponse
Log record representing an execution attempt and delivery response for a webhook target
Type
Backend_WebhookUpdate
Request payload to update an existing webhook subscription
Type
Common_Collection
Base collection
Type
Common_FormContainer
Represents a config form with a list of elements
Type
Common_FormElement
Form base element
Type
Common_FormElementCheckbox
Form element which represents a checkbox element
Type
Common_FormElementCollection
Form element which represents a collection element
Type
Common_FormElementInput
Form element which represents an input element
Type
Common_FormElementMap
Form element which represents a map element
Type
Common_FormElementSelect
Form element which represents a select element
Type
Common_FormElementSelectOption
Represents a concrete option entry
Type
Common_FormElementTextArea
Form element which represents a textarea
Type
Common_FormElementTypeAPI
Form element which represents a TypeAPI editor
Type
Common_FormElementTypeSchema
Form element which represents a TypeSchema editor
Type
Common_Message
Common error message
Type
Common_Metadata
Type
Consumer_Agent
This object represents an agent
Type
Consumer_AgentCollection
Represents a collection of agent messages
Type
Consumer_AgentMessage
This object represents an agent message
Type
Consumer_AgentMessageCollection
Represents a collection of agent messages
Type
Consumer_App
Represents a consumer application registered by a user
Type
Consumer_AppCollection
Collection of consumer applications
Type
Consumer_AppCreate
Payload for creating a new consumer application
Type
Consumer_AppUpdate
Payload for updating an existing consumer application
Type
Consumer_AuthorizeMeta
Metadata for an OAuth authorization request screen
Type
Consumer_AuthorizeRequest
Parameters sent to initiate an OAuth authorization decision
Type
Consumer_AuthorizeResponse
Result of an OAuth authorization decision
Type
Consumer_Event
Represents an event trigger definition within the platform
Type
Consumer_EventCollection
Collection of event definitions
Type
Consumer_Form
Dynamic form configuration entity
Type
Consumer_FormCollection
Collection of dynamic form definitions
Type
Consumer_Grant
Represents user authorization granted to a consumer application
Type
Consumer_GrantCollection
Collection of user authorization grant records
Type
Consumer_Identity
Identity provider configuration for single sign-on
Type
Consumer_IdentityCollection
Collection of third-party identity providers
Type
Consumer_Log
Access log entry recording an incoming HTTP request
Type
Consumer_LogCollection
Collection of access log records
Type
Consumer_Page
Content page definition for developer portal documentation
Type
Consumer_PageCollection
Collection of content page entries
Type
Consumer_PaymentCheckoutRequest
Request payload to initiate a checkout flow for a plan
Type
Consumer_PaymentCheckoutResponse
Response payload containing the payment provider checkout URI
Type
Consumer_PaymentPortalRequest
Request payload to launch the billing management portal
Type
Consumer_PaymentPortalResponse
Response payload containing the customer portal portal link
Type
Consumer_Plan
Subscription or monetization plan for API consumers
Type
Consumer_PlanCollection
Collection of subscription plans
Type
Consumer_Scope
Permission scope defining access rights to API endpoints
Type
Consumer_ScopeCategories
Grouped list of scope categories for user authorization forms
Type
Consumer_ScopeCategory
Category grouping related API scopes together
Type
Consumer_ScopeCategoryScope
Scope entry within a specific category group
Type
Consumer_ScopeCollection
Collection of API permission scopes
Type
Consumer_Token
Personal access token entity generated for consumer access
Type
Consumer_TokenAccessToken
OAuth 2.0 access token response object
Type
Consumer_TokenCollection
Collection of personal access tokens
Type
Consumer_TokenCreate
Payload for issuing a new personal access token
Type
Consumer_TokenUpdate
Payload for updating an existing personal access token
Type
Consumer_Transaction
Billing transaction record for quota or subscription purchases
Type
Consumer_TransactionCollection
Collection of transaction records
Type
Consumer_UserAccount
User profile and subscription status details
Type
Consumer_UserActivate
Payload used to activate a user account via token
Type
Consumer_UserEmail
Payload used to initiate account recovery or email requests
Type
Consumer_UserJWT
JWT authentication response containing access credentials
Type
Consumer_UserLogin
Credentials payload for user login
Type
Consumer_UserPasswordReset
Payload for completing a password reset
Type
Consumer_UserPlan
Active plan summary associated with a user
Type
Consumer_UserRefresh
Payload to request a refreshed authentication token
Type
Consumer_UserRegister
Payload for registering a new user account
Type
Consumer_Webhook
Webhook endpoint subscription definition
Type
Consumer_WebhookCollection
Collection of webhook subscriptions
Type
Consumer_WebhookCreate
Payload for registering a new webhook subscription
Type
Consumer_WebhookResponse
Recorded delivery log response for a webhook dispatch
Type
Consumer_WebhookUpdate
Payload for updating an existing webhook subscription
Type
MarketplaceAction
Type
MarketplaceActionCollection
Type
MarketplaceActionConfig
Type
MarketplaceApp
Type
MarketplaceAppCollection
Type
MarketplaceBundle
Type
MarketplaceBundleAction
Type
MarketplaceBundleActionConfig
Type
MarketplaceBundleCollection
Type
MarketplaceBundleConfig
Type
MarketplaceBundleCronjob
Type
MarketplaceBundleEvent
Type
MarketplaceBundleSchema
Type
MarketplaceBundleSchemaSource
Type
MarketplaceBundleTrigger
Type
MarketplaceCollection
Type
MarketplaceInstall
Installs an object from the marketplace
Type
MarketplaceMessage
Type
MarketplaceObject
Base class of all objects on the marketplace
Type
MarketplaceUser
Type
Passthru
No schema information available
Type
System_About
Type
System_AboutApps
Type
System_AboutLink
Type
System_CaptchaChallenge
Type
System_HealthCheck
Type
System_Route
Type
System_RouteMethod
Type
System_RoutePath
Type
System_Schema
Type
System_SchemaForm
Type
System_SchemaTypeSchema
Type
part of the Apioo-Project