Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Captions internal API

The internal API from Captions — 8 operation(s) for internal.

Captions internal API is one of 7 APIs that Captions publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include internal. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 11 operations across 8 paths, and defines 13 schemas. It is described by OpenAPI 3.1.0, at version 0.0.1.

Requests are made against the base URL https://api.mirage.app.

11 operations 8 paths 13 schemas 1 DELETE4 GET5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.0.1
Base URL
https://api.mirage.app
Resource Areas
1

Paths & Operations 11

Across 8 paths, the API surfaces 11 operations — 1 DELETE, 4 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

internal 11
POST
/internal/api-keys/generate
Create Api Key
create_api_key_internal_api_keys_generate_post 1 param body → 200422
POST
/internal/api-keys/{key_id}
Revoke Api Key
revoke_api_key_internal_api_keys__key_id__post 2 params → 200422
GET
/internal/api-keys/user/{user_id}
List User Api Keys
list_user_api_keys_internal_api_keys_user__user_id__get 3 params → 200422
POST
/internal/videos
Create Video
create_video_internal_videos_post 1 param body → 200422
GET
/internal/videos/{video_id}
Get Video
get_video_internal_videos__video_id__get 2 params → 200422
POST
/internal/rate-limits/overrides
Create Rate Limit Override
create_rate_limit_override_internal_rate_limits_overrides_post 1 param body → 201422
GET
/internal/rate-limits/overrides
List Rate Limit Overrides
list_rate_limit_overrides_internal_rate_limits_overrides_get 3 params → 200422
GET
/internal/rate-limits/overrides/{identifier}
Get Rate Limit Override
get_rate_limit_override_internal_rate_limits_overrides__identifier__get 2 params → 200422
PUT
/internal/rate-limits/overrides/{identifier}
Update Rate Limit Override
update_rate_limit_override_internal_rate_limits_overrides__identifier__put 2 params body → 200422
DELETE
/internal/rate-limits/overrides/{identifier}
Delete Rate Limit Override
delete_rate_limit_override_internal_rate_limits_overrides__identifier__delete 2 params → 204422
POST
/internal/rate-limits/overrides/{identifier}/invalidate-cache
Invalidate Rate Limit Override Cache
invalidate_rate_limit_override_cache_internal_rate_limits_overrides__identifier__invalidate_cache_post 2 params → 204422

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are MAVideo (12 properties), RateLimitOverrideResponse (7 properties), ApiKeyInfo (6 properties), Body_create_video_internal_videos_post (6 properties). Each schema is shown below with its type and property counts.

RateLimitOverrideResponse
object
Response containing rate limit override information
7 properties 4 required
ApiKeyInfo
object
6 properties 6 required
ValidationError
object
5 properties 3 required
MAVideoError
object
Error payload that explains why generation failed, if applicable
2 properties 2 required
HTTPValidationError
object
1 property
RateLimitOverrideUpdateRequest
object
Request to update a rate limit override
2 properties
MAVideo
object
Represents a video object. A video can be created via generation (an image appearance reference plus audio) or captioning (adding captions to an existing video…
12 properties 4 required
EndpointLimitsOverride
object
Rate limit overrides for specific endpoints
5 properties
CreateApiKeyResponse
object
2 properties 2 required
Body_create_video_internal_videos_post
object
6 properties
RateLimitOverrideCreateRequest
object
Request to create a rate limit override
3 properties 2 required
CreateApiKeyRequest
object
1 property
EndpointRateLimitConfig
object
Rate limit configuration for a specific endpoint
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

captions-internal-api-openapi.yml Raw ↑

Other APIs Captions publishes across the network.

Captions Audio API
Captions health API
Captions Meta Text Overlays API
Captions root API
Captions Video Captions API
Captions Videos API