/v1/job/{job_id}

Develop Env

https://dev.your-api-server.com

GET

/v1/jobs/{{job_id}}

The response depends on job status. View variations by selecting a response from the Example Response section's top-right dropdown.

This endpoint returns the status of the passed job_Id

This endpoint returns status for all background processing jobs such as: Generate Video Preview from Text, Transcribe Video, Render Video

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://dev.your-api-server.com/v1/jobs/{{job_id}}' \
--header 'Authorization: {{access_token}}' \
--header 'X-Pictory-User-Id: {{X-Pictory-User-Id}}'

Response Example

200 - v1 Job In Progress - v1 Job In Progress

{
    "job_id": "6830fe00-872b-4e96-86b5-e4b527f0295b",
    "success": true,
    "data": {
        "status": "in-progress"
    }
}

Request

Header Params

Authorization

string

required

Example:

X-Pictory-User-Id

string

required

Used for logging purposes

Example:

Responses

🟢200v1 Job In Progress

application/json

Body

job_id

string

required

success

boolean

required

data

object

required

status

string

required

🟢200v1 GET Default Video Settings (Text to Video API Flow)

🟢200v2 Get Default Transcription & Highlight Settings

🟢200v1 GET Default Transcription Settings (Video Editing Flow)

🟢200v1 GET Default Highlight Settings (Video Editing API Flow)

🟢200v1 GET Video Download URL (Final Step in all API Flows)

Modified at 2024-07-10 08:41:40

/v1/video/storyboard

/v1/media/generateUrl