> For the complete documentation index, see [llms.txt](https://docs.roboflow.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.roboflow.com/deploy/serverless/video-inference/api-reference.md). # API Reference The Video Inference API can be used through the Roboflow Python SDK and through a REST API. ### Base URL The API uses the following URL: ``` https://api.roboflow.com ``` ### API Methods We highly recommend accessing video inference via the roboflow Pip package.\ \ The raw Video Inference API at `https://api.roboflow.com` has three methods:
METHODDESCRIPTION
POST /video_upload_signed_url/?api_key={{WORKSPACE_API_KEY}}

This endpoint returns a signed URL where a user can upload video.

The endpoint accepts a JSON input with the filename, like so

{
    "file_name": "my_video_file.mp4"
}

A signed URL is returned

{
    "signed_url": "URL"
}


You can then use your favorite upload program (like cURL) to PUT your video file to the signed URL.

curl -X PUT "my_signed_url" \
-H "Content-Type: application/octet-stream" \
--data-binary "@your_video.mp4"
POST /videoinfer/?api_key={{WORKSPACE_API_KEY}}

The endpoint accepts a json input to schedule a video inference job for processing. Note that the INPUT_URL can be any publicly available URL, you don't need to first create a signed URL and then upload a video to Roboflow.

An example showing the body of the request is shown below:

{
    "input_url": "{{INPUT_URL}}",
    "infer_fps": 5,
    "models": [
        {
            "model_id": "rock-paper-scissors-presentation",
            "model_version": "4",
            "inference_type": "object-detection",
            "inference_params": {"confidence": 0.4}
        }
    ]
}

Please be noted that models[*].inference_params is optional.

The response is a JSON string, like so

{
    "job_id": "fec28362-f7d9-4cc0-a805-5e94495d063d",
    "message": "This endpoint will create videojob"
}


You can specify multiple models in the models array. The infer_fps field should be at least set to 1 and its value should not exceed the video frame-rate. For most use-cases, the video frame rate is an exact multiple of the infer_fps .

GET /videoinfer/?api_key={{WORKSPACE_API_KEY}}&job_id={{JOB_ID}}This endpoint returns the current status of the job. This endpoint is rate-limited, please don't poll this endpoint more than once per minute.

When the job is successful, the returned JSON's status key is set to 0, and the output_signed_url key contains the download link for the video inference results.

If the status is set to 1, it indicates that the job processing is not complete. Any higher values indicates job failure.
Once you have downloaded the JSON file stored from the `output_signed_url` location, you can parse it to obtain inference information. The format of the json file is [described here](https://inference.roboflow.com/workflows/definitions/). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## 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, and the optional `goal` query parameter: ``` GET https://docs.roboflow.com/deploy/serverless/video-inference/api-reference.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.