generated: '2026-09-23'
method: derived
generator: derive-vocabulary.py
source:
- openapi/apimatic-docs-portal-api-openapi.yml
- openapi/apimatic-docs-portal-async-api-openapi.yml
- openapi/apimatic-sdk-api-openapi.yml
- openapi/apimatic-sdk-async-api-openapi.yml
- openapi/apimatic-transformation-api-openapi.yml
vocabulary:
  name: APIMatic Domain Vocabulary
  description: 'Terms declared by APIMatic''s own API contract: its resource groups, objects and enumerations, with the contract''s definitions.
    Derived, not authored.'
  version: '2026-09-23'
  terms:
  - term: UnauthorizedResponse
    definition: 'Object declared by the contract with fields: message.'
    tags:
    - Object
    source: openapi/apimatic-docs-portal-api-openapi.yml#/components/schemas/UnauthorizedResponse
  - term: InternalServerErrorResponse
    definition: 'Object declared by the contract with fields: message.'
    tags:
    - Object
    source: openapi/apimatic-docs-portal-api-openapi.yml#/components/schemas/InternalServerErrorResponse
  - term: ProblemDetails
    definition: 'Object declared by the contract with fields: type, title, status, detail, instance, errors.'
    tags:
    - Object
    source: openapi/apimatic-docs-portal-api-openapi.yml#/components/schemas/ProblemDetails
  - term: PortalGenerationAsyncResponse
    definition: 'Object declared by the contract with fields: id, links.'
    tags:
    - Object
    source: openapi/apimatic-docs-portal-async-api-openapi.yml#/components/schemas/PortalGenerationAsyncResponse
  - term: PortalGenerationStatusResponse
    definition: 'Object declared by the contract with fields: status, errors.'
    tags:
    - Object
    source: openapi/apimatic-docs-portal-async-api-openapi.yml#/components/schemas/PortalGenerationStatusResponse
  - term: Links
    definition: 'Object declared by the contract with fields: status, download.'
    tags:
    - Object
    source: openapi/apimatic-docs-portal-async-api-openapi.yml#/components/schemas/Links
  - term: Status
    definition: 'Enumeration declared by the contract with values: Completed, InProgress, ValidationError, SubscriptionError, Failed.'
    tags:
    - Enumeration
    source: openapi/apimatic-docs-portal-async-api-openapi.yml#/components/schemas/Status
  - term: GenerateSdkViaUrlRequest
    definition: 'Object declared by the contract with fields: url, template.'
    tags:
    - Object
    source: openapi/apimatic-sdk-api-openapi.yml#/components/schemas/GenerateSdkViaUrlRequest
  - term: UserCodeGeneration
    definition: The Code Generation structure encapsulates all the the details of an SDK generation performed by a user.
    tags:
    - Object
    source: openapi/apimatic-sdk-api-openapi.yml#/components/schemas/UserCodeGeneration
  - term: BadRequestResponseSDK
    definition: Standard JSON error response for bad requests
    tags:
    - Object
    source: openapi/apimatic-sdk-api-openapi.yml#/components/schemas/BadRequestResponseSDK
  - term: Platforms
    definition: The structure contains platforms that APIMatic CodeGen can generate SDKs and Docs in.
    tags:
    - Enumeration
    source: openapi/apimatic-sdk-api-openapi.yml#/components/schemas/Platforms
  - term: SDK Languages
    definition: Languages for which SDKs can be generated.
    tags:
    - Enumeration
    source: openapi/apimatic-sdk-async-api-openapi.yml#/components/schemas/SDKLanguages
  - term: SdkGenerationStatusResponse
    definition: 'Object declared by the contract with fields: status, errors.'
    tags:
    - Object
    source: openapi/apimatic-sdk-async-api-openapi.yml#/components/schemas/SdkGenerationStatusResponse
  - term: SdkGenerationAsyncResponse
    definition: 'Object declared by the contract with fields: id, links.'
    tags:
    - Object
    source: openapi/apimatic-sdk-async-api-openapi.yml#/components/schemas/SdkGenerationAsyncResponse
  - term: Transformation
    definition: Transformation structure encapsulates all the details of a Transformation.
    tags:
    - Object
    source: openapi/apimatic-transformation-api-openapi.yml#/components/schemas/Transformation
  - term: TransformViaUrlRequest
    definition: This structure puts together the URL of the file to be transformed, along with the desired export format.
    tags:
    - Object
    source: openapi/apimatic-transformation-api-openapi.yml#/components/schemas/TransformViaUrlRequest
  - term: ExportFormats
    definition: The structure contains API specification formats that Transformer can convert to.
    tags:
    - Enumeration
    source: openapi/apimatic-transformation-api-openapi.yml#/components/schemas/ExportFormats
  - term: ApiValidationSummary
    definition: 'Object declared by the contract with fields: success, errors, warnings, messages.'
    tags:
    - Object
    source: openapi/apimatic-transformation-api-openapi.yml#/components/schemas/ApiValidationSummary
  - term: ValidateApiResult
    definition: 'Object declared by the contract with fields: validation, linting.'
    tags:
    - Object
    source: openapi/apimatic-validation-v2-api-openapi.yml#/components/schemas/ValidateApiResult
  - term: ValidationEntry
    definition: 'Object declared by the contract with fields: message, lineInfo, jsonReferencePath, fileReference, metadata, ruleDocumentationReference,
      additionalReferences.'
    tags:
    - Object
    source: openapi/apimatic-validation-v2-api-openapi.yml#/components/schemas/ValidationEntry
  - term: LineInfo
    definition: 'Object declared by the contract with fields: startLineNumber, startLinePosition, endLineNumber, endLinePosition.'
    tags:
    - Object
    source: openapi/apimatic-validation-v2-api-openapi.yml#/components/schemas/LineInfo
  - term: ValidationSummary
    definition: 'Object declared by the contract with fields: isSuccess, blocking, errors, warnings, information.'
    tags:
    - Object
    source: openapi/apimatic-validation-v2-api-openapi.yml#/components/schemas/ValidationSummary