Smartcat

Smartcat Smartwords API

The Smartwords API from Smartcat — 1 operation(s) for smartwords.

GitHub OpenAPI

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/smartcat/refs/heads/main/authentication/smartcat-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/smartcat/refs/heads/main/openapi/smartcat-smartwords-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/smartcat/refs/heads/main/errors/smartcat-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/smartcat/refs/heads/main/conventions/smartcat-conventions.yml
🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/smartcat/refs/heads/main/conventions/smartcat-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/smartcat/refs/heads/main/data-model/smartcat-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/smartcat/refs/heads/main/asyncapi/smartcat-callbacks-webhooks.yml

OpenAPI Specification

smartcat-smartwords-api-openapi.yml Raw ↑ 
openapi: 3.0.1
info:
  title: Smartcat Account Smartwords API
  version: v1
servers:
- url: /
tags:
- name: Smartwords
paths:
  /api/integration/v1/smartwords/balance:
    get:
      tags:
      - Smartwords
      summary: Fetch the current Smartwords balance of the workspace
      responses:
        '200':
          description: Request has been successfully completed
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SmartwordsBalanceModel'
            application/json:
              schema:
                $ref: '#/components/schemas/SmartwordsBalanceModel'
            text/json:
              schema:
                $ref: '#/components/schemas/SmartwordsBalanceModel'
components:
  schemas:
    SmartwordsBalanceModel:
      type: object
      properties:
        balance:
          type: integer
          description: Current Smartwords balance available to the workspace
          format: int32
      additionalProperties: false
      description: Smartwords balance of the workspace