# Models

## The CreateRevCaptionOrder object

```json
{"openapi":"3.1.1","info":{"title":"Rev Caption API","version":"1.0"},"components":{"schemas":{"CreateRevCaptionOrder":{"title":"CreateRevCaptionOrder","required":["ClientApiKey","UserApiKey","VideoId"],"properties":{"ClientApiKey":{"description":"This is a secret key specific to each partner that wishes to use the Rev Entertainment.","type":"string"},"UserApiKey":{"description":"This is a secret key specific to a Rev user, which identifies the user account under whose privileges the requested operation executes. This key can be obtained by logging in to Rev as the user in question and going to the Rev Account Settings page.","type":"string"},"ReferenceId":{"description":"Optional order reference number.","type":"string"},"VideoId":{"description":"ID of video to caption.","type":"integer","format":"int64"},"NotificationUrl":{"description":"Optional URL to send notifications when order is complete.","type":"string"},"UseSandbox":{"description":"Optional URL to send notifications when order is complete.","type":"boolean"}},"description":"CreateRevCaptionOrder","type":"object"}}}}
```

## The GetRevCaptions object

```json
{"openapi":"3.1.1","info":{"title":"Rev Caption API","version":"1.0"},"components":{"schemas":{"GetRevCaptions":{"title":"GetRevCaptions","required":["Take"],"properties":{"Take":{"description":"Limits the total items returned. Maximum of 100 per request.","type":"integer","format":"int32"},"Skip":{"description":"Skips records using for paging results.","type":"integer","format":"int32"}},"description":"GetRevCaptions","type":"object"}}}}
```

## The GetRevCaptionAttachmentContent object

```json
{"openapi":"3.1.1","info":{"title":"Rev Caption API","version":"1.0"},"components":{"schemas":{"GetRevCaptionAttachmentContent":{"title":"GetRevCaptionAttachmentContent","required":["Id","Type"],"properties":{"Id":{"description":"Caption Order Id.","type":"integer","format":"int64"},"Type":{"description":"Type of caption content.","type":"string","enum":["WebVTT","Ttml","SubRip","Scc","Mcc","QtText","Transcript","Dfxp","CheetaCap","Stl","AvidDs","FacebookSubRip","Unknown"]}},"description":"GetRevCaptionAttachmentContent","type":"object"}}}}
```

## The CaptionOrderResponse object

```json
{"openapi":"3.1.1","info":{"title":"Rev Caption API","version":"1.0"},"components":{"schemas":{"CaptionOrderResponse":{"title":"CaptionOrderResponse","properties":{"Id":{"type":"integer","format":"int64"},"Status":{"type":"string"}},"description":"CaptionOrderResponse","type":"object"}}}}
```

## The AllRevCaptionsResponse object

```json
{"openapi":"3.1.1","info":{"title":"Rev Caption API","version":"1.0"},"components":{"schemas":{"AllRevCaptionsResponse":{"title":"AllRevCaptionsResponse","properties":{"TotalCount":{"description":"Total count of captions.","type":"integer","format":"int64"},"Skip":{"description":"Records to skip used with paging.","type":"integer","format":"int32"},"Take":{"description":"Page size.","type":"integer","format":"int32"},"Result":{"type":"array","items":{"$ref":"#/components/schemas/RevCaptionsResponse"}}},"description":"AllRevCaptionsResponse","type":"object"},"RevCaptionsResponse":{"title":"RevCaptionsResponse","properties":{"Id":{"description":"Caption Order Id.  Use this ID to get individual captions.","type":"integer","format":"int64"},"VideoId":{"description":"ID of the video getting captioned.","type":"integer","format":"int64"},"OrderNumber":{"description":"Rev internal order number.","type":"string"},"ReferenceId":{"description":"Optional reference Id used when creating the order.","type":"string"},"Status":{"description":"Status of the order.","type":"string"},"Comments":{"description":"List of comments from Rev.","type":"array","items":{"$ref":"#/components/schemas/RevOrderComment"}},"Captions":{"description":"List of captions.","type":"array","items":{"$ref":"#/components/schemas/RevCaptionItem"}},"Created":{"description":"DateTime order was placed.","type":"string","format":"date-time"},"Modified":{"description":"DateTime order was last modified.","type":"string","format":"date-time"},"UseSandbox":{"description":"Determines if order was placed using Rev's testing environment. ","type":"boolean"}},"description":"RevCaptionsResponse","type":"object"},"RevOrderComment":{"title":"RevOrderComment","properties":{"by":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"text":{"type":"string"}},"description":"RevOrderComment","type":"object"},"RevCaptionItem":{"title":"RevCaptionItem","properties":{"Kind":{"type":"string"},"Text":{"type":"string"},"Content_Type":{"type":"string"}},"description":"RevCaptionItem","type":"object"}}}}
```

## The RevCaptionsResponse object

```json
{"openapi":"3.1.1","info":{"title":"Rev Caption API","version":"1.0"},"components":{"schemas":{"RevCaptionsResponse":{"title":"RevCaptionsResponse","properties":{"Id":{"description":"Caption Order Id.  Use this ID to get individual captions.","type":"integer","format":"int64"},"VideoId":{"description":"ID of the video getting captioned.","type":"integer","format":"int64"},"OrderNumber":{"description":"Rev internal order number.","type":"string"},"ReferenceId":{"description":"Optional reference Id used when creating the order.","type":"string"},"Status":{"description":"Status of the order.","type":"string"},"Comments":{"description":"List of comments from Rev.","type":"array","items":{"$ref":"#/components/schemas/RevOrderComment"}},"Captions":{"description":"List of captions.","type":"array","items":{"$ref":"#/components/schemas/RevCaptionItem"}},"Created":{"description":"DateTime order was placed.","type":"string","format":"date-time"},"Modified":{"description":"DateTime order was last modified.","type":"string","format":"date-time"},"UseSandbox":{"description":"Determines if order was placed using Rev's testing environment. ","type":"boolean"}},"description":"RevCaptionsResponse","type":"object"},"RevOrderComment":{"title":"RevOrderComment","properties":{"by":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"text":{"type":"string"}},"description":"RevOrderComment","type":"object"},"RevCaptionItem":{"title":"RevCaptionItem","properties":{"Kind":{"type":"string"},"Text":{"type":"string"},"Content_Type":{"type":"string"}},"description":"RevCaptionItem","type":"object"}}}}
```

## The RevOrderComment object

```json
{"openapi":"3.1.1","info":{"title":"Rev Caption API","version":"1.0"},"components":{"schemas":{"RevOrderComment":{"title":"RevOrderComment","properties":{"by":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"text":{"type":"string"}},"description":"RevOrderComment","type":"object"}}}}
```

## The RevCaptionItem object

```json
{"openapi":"3.1.1","info":{"title":"Rev Caption API","version":"1.0"},"components":{"schemas":{"RevCaptionItem":{"title":"RevCaptionItem","properties":{"Kind":{"type":"string"},"Text":{"type":"string"},"Content_Type":{"type":"string"}},"description":"RevCaptionItem","type":"object"}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://knowledgebase.fabricdata.com/origin/apis-all/captions-and-translations-api-docs/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.