Skip to main content
GET
/
v1
/
projects
/
{project_id}
Get project
curl --request GET \
  --url http://api/v1/projects/{project_id} \
  --header 'X-API-Key: <api-key>'
{
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "username": "<string>",
  "videoUrl": "<string>",
  "avatarImageUrl": "<string>",
  "aspectRatio": "1:1",
  "text": "<string>",
  "voiceId": "<string>",
  "voiceUrl": "<string>",
  "userId": "<string>",
  "jobType": "<string>",
  "status": "Queued",
  "stage": "<string>",
  "progress": 123,
  "errorMessage": "<string>",
  "audioSource": "<string>",
  "avatarImageInput": {},
  "shared": false
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
project_id
string
required

Response

Successful Response

​
aspectRatio
enum<string>
required
Available options:
1:1,
16:9,
9:16
​
id
string | null
​
createdAt
string<date-time> | null
​
username
string | null
​
videoUrl
string | null
​
avatarImageUrl
string | null
​
text
string | null
​
voiceId
string | null
​
voiceUrl
string | null
​
userId
string | null
​
jobType
string | null
​
status
enum<string> | null
Available options:
Queued,
InProgress,
Completed,
Failed
​
stage
string | null
​
progress
number | null
​
errorMessage
string | null
​
audioSource
string | null
​
avatarImageInput
object | null
​
shared
boolean
default:false