Skip to main content
GET
/
v1
/
capabilities
List render and task capabilities
curl --request GET \
  --url https://api.framelane.io/v1/capabilities
{
  "api_version": "<string>",
  "output_formats": [
    {
      "value": "<string>",
      "description": "<string>",
      "supported": true,
      "alpha_capable": true
    }
  ],
  "input_formats": [
    {
      "extension": "<string>",
      "mime_type": "<string>",
      "kind": "<string>"
    }
  ],
  "element_types": [
    {
      "value": "<string>",
      "description": "<string>",
      "supported": true
    }
  ],
  "effects": [
    {
      "value": "<string>",
      "description": "<string>",
      "supported": true
    }
  ],
  "motions": [
    {
      "value": "<string>",
      "description": "<string>",
      "supported": true,
      "element_entrance": true,
      "element_exit": true,
      "character": true
    }
  ],
  "transitions": [
    {
      "value": "<string>",
      "description": "<string>",
      "supported": true
    }
  ],
  "word_animations": [
    {
      "value": "<string>",
      "description": "<string>",
      "supported": true
    }
  ],
  "progress_bar_styles": [
    {
      "value": "<string>",
      "description": "<string>",
      "supported": true
    }
  ],
  "audio_viz_styles": [
    {
      "value": "<string>",
      "description": "<string>",
      "supported": true
    }
  ],
  "blend_modes": [
    {
      "value": "<string>",
      "description": "<string>",
      "supported": true
    }
  ],
  "easings": [
    {
      "value": "<string>",
      "description": "<string>",
      "supported": true
    }
  ],
  "motion_scopes": [
    {
      "value": "<string>",
      "description": "<string>",
      "supported": true
    }
  ],
  "task_types": [
    {
      "value": "<string>",
      "description": "<string>",
      "provider": "<string>",
      "params": [
        {
          "name": "<string>",
          "type": "<string>",
          "required": true,
          "minimum": 123,
          "maximum": 123,
          "default": "<unknown>",
          "options": [
            "<string>"
          ],
          "description": "<string>"
        }
      ]
    }
  ],
  "limits": {
    "canvas_min": 123,
    "canvas_max": 123,
    "frame_rate_min": 123,
    "frame_rate_max": 123,
    "frame_rate_default": 123,
    "max_source_bytes": 123,
    "pagination_default_limit": 123,
    "pagination_max_limit": 123
  },
  "rate_limits": [
    {
      "scope": "<string>",
      "limit": 123,
      "window_seconds": 123
    }
  ]
}

Response

200 - application/json

Successful Response

The full capability catalog returned by GET /v1/capabilities.

api_version
string
required

API build version this catalog reflects.

output_formats
OutputFormatCap · object[]
required
input_formats
InputFormatCap · object[]
required
element_types
EnumValueCap · object[]
required
effects
EnumValueCap · object[]
required
motions
MotionCap · object[]
required
transitions
EnumValueCap · object[]
required
word_animations
EnumValueCap · object[]
required
progress_bar_styles
EnumValueCap · object[]
required
audio_viz_styles
EnumValueCap · object[]
required
blend_modes
EnumValueCap · object[]
required
easings
EnumValueCap · object[]
required
motion_scopes
EnumValueCap · object[]
required
task_types
TaskTypeCap · object[]
required
limits
Limits · object
required
rate_limits
RateLimit · object[]
required